Skip to main content
GET
/
v0
/
component
/
diff
/
{id}
Get component diff between two versions
curl --request GET \
  --url https://{hostname}.gable.ai/v0/component/diff/{id} \
  --header 'X-API-KEY: <api-key>'
{
  "metadata": {
    "componentName": "<string>",
    "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "baseEventId": "<string>",
    "baseDate": "2023-11-07T05:31:56Z",
    "compareEventId": "<string>",
    "compareDate": "2023-11-07T05:31:56Z",
    "totalAdded": 123,
    "totalRemoved": 123,
    "totalModified": 123,
    "baseLabel": "<string>",
    "baseCommitSha": "<string>",
    "compareLabel": "<string>",
    "compareCommitSha": "<string>",
    "totalUnchanged": 123
  },
  "pathChanges": [
    {
      "pathId": "<string>",
      "ingressName": "<string>",
      "egressName": "<string>",
      "fieldsAdded": 123,
      "fieldsRemoved": 123,
      "fieldsChanged": 123,
      "totalFields": 123,
      "codeStepsAdded": 123,
      "codeStepsRemoved": 123,
      "codeStepsModified": 123,
      "fields": [
        {
          "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
            }
          ]
        }
      ],
      "basePathId": "<string>",
      "comparePathId": "<string>",
      "ingressFunction": "<string>",
      "egressFunction": "<string>"
    }
  ]
}

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

​
scanOnly
boolean
default:false

When true, load lineage from raw scan snapshots and return summary counts only (no field details).

Response

Component diff retrieved successfully

Response for the component diff API, comparing two versions of a component's lineage.

​
metadata
object
required

Metadata for a component diff comparison.

​
pathChanges
object[]
required

List of path-level diffs between the two versions.