Get all components - Gable Docs

GET

cross-service-components

Get all components

curl --request GET \
  --url https://{hostname}.gable.ai/v0/cross-service-components \
  --header 'X-API-KEY: <api-key>'

{
  "components": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "runId": "<string>",
      "name": "<string>",
      "ingresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "kind": "<string>",
          "schema": {
            "type": "struct",
            "name": "<string>",
            "fields": [
              {
                "type": "struct",
                "name": "<string>",
                "fields": "<array>",
                "alias": "<string>",
                "doc": "<string>",
                "logical": "<string>",
                "optional": true
              }
            ],
            "alias": "<string>",
            "doc": "<string>",
            "logical": "<string>"
          },
          "signatureName": "<string>"
        }
      ],
      "egresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "kind": "<string>",
          "schema": {
            "type": "struct",
            "name": "<string>",
            "fields": [
              {
                "type": "struct",
                "name": "<string>",
                "fields": "<array>",
                "alias": "<string>",
                "doc": "<string>",
                "logical": "<string>",
                "optional": true
              }
            ],
            "alias": "<string>",
            "doc": "<string>",
            "logical": "<string>"
          },
          "signatureName": "<string>"
        }
      ],
      "paths": [
        {
          "ingress": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "codeAnchorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "description": "<string>"
          },
          "egress": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "codeAnchorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "description": "<string>"
          },
          "codeAnchors": [
            {
              "anchorId": "<string>",
              "name": "<string>",
              "codeUri": {
                "file": "<string>",
                "lineStart": 123,
                "columnStart": 123,
                "lineEnd": 123,
                "columnEnd": 123
              },
              "url": "<string>"
            }
          ],
          "fieldMappings": [
            {
              "ingressField": "<string>",
              "egressField": "<string>",
              "notes": "<string>"
            }
          ],
          "transformationSummary": "<string>",
          "transformationSummaryDetailed": "<string>"
        }
      ],
      "type": "<string>",
      "metadata": {
        "extras": {}
      }
    }
  ],
  "edge_mappings": [
    {
      "id": "<string>",
      "crossServiceFieldMappings": [
        {
          "sourceField": "<string>",
          "destinationField": "<string>"
        }
      ],
      "source": {
        "componentId": "<string>",
        "type": "egress",
        "egressId": "<string>"
      },
      "destination": {
        "componentId": "<string>",
        "type": "ingress",
        "ingressId": "<string>"
      },
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

Response

Successful operation

The response for the cross service components.

components

object[]

required

The component for the cross service components.

Option 1
Option 2

Show child attributes

components.id

string<uuid>

required

The unique identifier for the component.

components.runId

string

required

The ID of the run that the component belongs to

components.name

string

required

The name of the component.

components.ingresses

object[]

required

The ingresses associated with the component.

Show child attributes

components.ingresses.id

string<uuid>

required

The unique identifier for the ingress/egress.

components.ingresses.kind

string

required

The kind of the ingress/egress.

components.ingresses.schema

object

required

The schema of the ingress/egress.

Show child attributes

components.ingresses.schema.type

enum<string>

required

Available options:

struct

components.ingresses.schema.name

string

components.ingresses.schema.fields

object[]

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Option 10
Option 11
Option 12
Option 13

Show child attributes

components.ingresses.schema.fields.type

enum<string>

required

Available options:

struct

components.ingresses.schema.fields.name

string

components.ingresses.schema.fields.fields

array

components.ingresses.schema.fields.alias

string

components.ingresses.schema.fields.doc

string

components.ingresses.schema.fields.logical

string

components.ingresses.schema.fields.optional

boolean

components.ingresses.schema.alias

string

components.ingresses.schema.doc

string

components.ingresses.schema.logical

string

components.ingresses.signatureName

string

The name of the package, class, or method that the ingress/egress point is associated with.

components.egresses

object[]

required

The egresses associated with the component.

Show child attributes

components.egresses.id

string<uuid>

required

The unique identifier for the ingress/egress.

components.egresses.kind

string

required

The kind of the ingress/egress.

components.egresses.schema

object

required

The schema of the ingress/egress.

Show child attributes

components.egresses.schema.type

enum<string>

required

Available options:

struct

components.egresses.schema.name

string

components.egresses.schema.fields

object[]

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Option 10
Option 11
Option 12
Option 13

Show child attributes

components.egresses.schema.fields.type

enum<string>

required

Available options:

struct

components.egresses.schema.fields.name

string

components.egresses.schema.fields.fields

array

components.egresses.schema.fields.alias

string

components.egresses.schema.fields.doc

string

components.egresses.schema.fields.logical

string

components.egresses.schema.fields.optional

boolean

components.egresses.schema.alias

string

components.egresses.schema.doc

string

components.egresses.schema.logical

string

components.egresses.signatureName

string

The name of the package, class, or method that the ingress/egress point is associated with.

components.paths

object[]

required

The paths associated with the component.

Show child attributes

components.paths.ingress

object

required

Show child attributes

components.paths.ingress.id

string<uuid>

required

The unique identifier of the ingress where the path starts.

components.paths.ingress.codeAnchorId

string<uuid>

The unique identifier of the code anchor node where the path starts (optional for BYOL imports).

components.paths.ingress.description

string

An AI-generated summary of the ingress point.

components.paths.egress

object

required

Show child attributes

components.paths.egress.id

string<uuid>

required

The unique identifier of the egress where the path ends.

components.paths.egress.codeAnchorId

string<uuid>

The unique identifier of the code anchor node where the path starts (optional for BYOL imports).

components.paths.egress.description

string

An AI-generated summary of the egress point.

components.paths.codeAnchors

object[]

required

A list of node IDs that are part of this path.

Show child attributes

components.paths.codeAnchors.anchorId

string

required

Unique identifier for the anchor.

components.paths.codeAnchors.name

string

required

Human readable name of the code anchor.

components.paths.codeAnchors.codeUri

object

required

Code URI is a unique identifier for a code location. It is used to identify the code location in the codebase.

Show child attributes

components.paths.codeAnchors.codeUri.file

string

required

Relative file path in the repo.

components.paths.codeAnchors.codeUri.lineStart

integer

required

components.paths.codeAnchors.codeUri.columnStart

integer

required

components.paths.codeAnchors.codeUri.lineEnd

integer

components.paths.codeAnchors.codeUri.columnEnd

integer

components.paths.codeAnchors.url

string

URL to the code anchor.

components.paths.fieldMappings

object[]

required

A list of field mappings that describe how fields are mapped along the path.

Show child attributes

components.paths.fieldMappings.ingressField

string

required

The name of the ingress field in the mapping.

components.paths.fieldMappings.egressField

string

required

The name of the egress field in the mapping.

components.paths.fieldMappings.notes

string

Additional notes about the field mapping.

components.paths.transformationSummary

string

An AI-generated summary of the data transformation that occurs along this path.

components.paths.transformationSummaryDetailed

string

A detailed AI-generated summary of the data transformation that occurs along this path.

components.type

string

required

The type of the component.

Allowed value: "CODE"

components.metadata

object

Show child attributes

components.metadata.extras

object

Additional metadata for the code component.

Show child attributes

components.metadata.extras.{key}

string

edge_mappings

object[]

required

Show child attributes

edge_mappings.id

string

required

The id of the edge.

edge_mappings.crossServiceFieldMappings

object[]

required

The field mappings for the cross service components.

Show child attributes

edge_mappings.crossServiceFieldMappings.sourceField

string

required

edge_mappings.crossServiceFieldMappings.destinationField

string

required

edge_mappings.source

object

required

The source of the edge.

Show child attributes

edge_mappings.source.componentId

string

required

The id of the component.

edge_mappings.source.type

string

required

The type of the source connection.

Example:

"egress"

edge_mappings.source.egressId

string

The id of the egress.

edge_mappings.destination

object

required

The destination of the edge.

Show child attributes

edge_mappings.destination.componentId

string

required

The id of the component.

edge_mappings.destination.type

string

required

The type of the destination connection.

Example:

"ingress"

edge_mappings.destination.ingressId

string

The id of the ingress.

edge_mappings.type

string

required

Allowed value: "EDGE"

Export lineageExport lineage

⌘I

Get all components

curl --request GET \
  --url https://{hostname}.gable.ai/v0/cross-service-components \
  --header 'X-API-KEY: <api-key>'

{
  "components": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "runId": "<string>",
      "name": "<string>",
      "ingresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "kind": "<string>",
          "schema": {
            "type": "struct",
            "name": "<string>",
            "fields": [
              {
                "type": "struct",
                "name": "<string>",
                "fields": "<array>",
                "alias": "<string>",
                "doc": "<string>",
                "logical": "<string>",
                "optional": true
              }
            ],
            "alias": "<string>",
            "doc": "<string>",
            "logical": "<string>"
          },
          "signatureName": "<string>"
        }
      ],
      "egresses": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "kind": "<string>",
          "schema": {
            "type": "struct",
            "name": "<string>",
            "fields": [
              {
                "type": "struct",
                "name": "<string>",
                "fields": "<array>",
                "alias": "<string>",
                "doc": "<string>",
                "logical": "<string>",
                "optional": true
              }
            ],
            "alias": "<string>",
            "doc": "<string>",
            "logical": "<string>"
          },
          "signatureName": "<string>"
        }
      ],
      "paths": [
        {
          "ingress": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "codeAnchorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "description": "<string>"
          },
          "egress": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "codeAnchorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "description": "<string>"
          },
          "codeAnchors": [
            {
              "anchorId": "<string>",
              "name": "<string>",
              "codeUri": {
                "file": "<string>",
                "lineStart": 123,
                "columnStart": 123,
                "lineEnd": 123,
                "columnEnd": 123
              },
              "url": "<string>"
            }
          ],
          "fieldMappings": [
            {
              "ingressField": "<string>",
              "egressField": "<string>",
              "notes": "<string>"
            }
          ],
          "transformationSummary": "<string>",
          "transformationSummaryDetailed": "<string>"
        }
      ],
      "type": "<string>",
      "metadata": {
        "extras": {}
      }
    }
  ],
  "edge_mappings": [
    {
      "id": "<string>",
      "crossServiceFieldMappings": [
        {
          "sourceField": "<string>",
          "destinationField": "<string>"
        }
      ],
      "source": {
        "componentId": "<string>",
        "type": "egress",
        "egressId": "<string>"
      },
      "destination": {
        "componentId": "<string>",
        "type": "ingress",
        "ingressId": "<string>"
      },
      "type": "<string>"
    }
  ]
}

Introduction

Gable

Authorizations

Response