Skip to main content
GET
/
v0
/
component
/
path-diff
/
{id}
Get path diff between two versions
curl --request GET \
  --url https://{hostname}.gable.ai/v0/component/path-diff/{id} \
  --header 'X-API-KEY: <api-key>'
{
  "metadata": {
    "componentName": "<string>",
    "ingressPayloadName": "<string>",
    "egressPayloadName": "<string>",
    "baseEventId": "<string>",
    "baseDate": "2023-11-07T05:31:56Z",
    "compareEventId": "<string>",
    "compareDate": "2023-11-07T05:31:56Z",
    "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ingressComponent": "<string>",
    "egressComponent": "<string>"
  },
  "diff": {
    "codeFlowSteps": [
      {
        "id": "<string>",
        "label": "<string>",
        "sublabel": "<string>",
        "componentName": "<string>",
        "isIngress": true,
        "isEgress": true,
        "isChanged": true,
        "changeBadge": "<string>",
        "file": "<string>",
        "lineStart": 123,
        "lineEnd": 123,
        "previousFile": "<string>",
        "previousLineStart": 123,
        "previousLineEnd": 123
      }
    ],
    "codeFlowChangeCount": 123,
    "fieldMappings": [
      {
        "sourceField": "<string>",
        "targetField": "<string>",
        "type": "<string>",
        "dataFlowSteps": [
          {
            "anchorId": "<string>",
            "file": "<string>",
            "lineStart": 123,
            "lineEnd": 123,
            "columnStart": 123,
            "columnEnd": 123
          }
        ],
        "previousDataFlowSteps": [
          {
            "anchorId": "<string>",
            "file": "<string>",
            "lineStart": 123,
            "lineEnd": 123,
            "columnStart": 123,
            "columnEnd": 123
          }
        ]
      }
    ],
    "fieldMappingChangeCount": 123
  }
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string<uuid>
required

UUID of the component

Query Parameters

base
string
required

Base event ID for comparison

compare
string
required

Compare event ID for comparison

ingress
string
required

Payload name of the ingress boundary

egress
string
required

Payload name of the egress boundary

basePathId
string

Path ID from the base version. When provided, filters to a specific path instead of merging all matching paths.

comparePathId
string

Path ID from the compare version. When provided, filters to a specific path instead of merging all matching paths.

scanOnly
boolean
default:false

When true, load lineage from raw scan snapshots instead of projected results.

Response

Path diff retrieved successfully

Response for the path diff API, comparing a single path between two component versions.

metadata
object
required

Metadata for a path diff comparison.

diff
object
required

Detailed diff of a single path between two versions, including code flow steps and field mappings.