Get component diff between two versions - Gable Docs

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

GET / v0 /component diff {id}

Get component diff between two versions

cURL

curl --request GET \
  --url https://demo-api.gable.ai/v0/component/diff/{id} \
  --header 'X-API-KEY: <api-key>'

Python

import requests

url = "https://demo-api.gable.ai/v0/component/diff/{id}"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

JavaScript

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://demo-api.gable.ai/v0/component/diff/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://demo-api.gable.ai/v0/component/diff/{id}",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "GET",\
  CURLOPT_HTTPHEADER => [\
    "X-API-KEY: <api-key>"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Go

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://demo-api.gable.ai/v0/component/diff/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-KEY", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}

Java

HttpResponse<String> response = Unirest.get("https://demo-api.gable.ai/v0/component/diff/{id}")
  .header("X-API-KEY", "<api-key>")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://demo-api.gable.ai/v0/component/diff/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

Response Codes

• 200: Component diff retrieved successfully
• 400: Bad request
• 500: Internal server error

Metadata

{
  "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
            }
          ],
          "upstreamDependencies": [
            {
              "componentName": "<string>",
              "field": "<string>",
              "hops": 123,
              "path": [
                {
                  "componentName": "<string>",
                  "field": "<string>"
                }
              ]
            }
          ],
          "downstreamDependencies": [
            {
              "componentName": "<string>",
              "field": "<string>",
              "hops": 123,
              "path": [
                {
                  "componentName": "<string>",
                  "field": "<string>"
                }
              ]
            }
          ]
        }
      ],
      "basePathId": "<string>",
      "comparePathId": "<string>",
      "ingressFunction": "<string>",
      "egressFunction": "<string>"
    }
  ]
}

Additional Messages

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}