Get path diff between two versions - Gable Docs

Get Path Diff Between Two Versions

Get path diff between two versions.

cURL Example

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

Python Example

import requests

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

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

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

print(response.text)

JavaScript (Fetch) Example

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

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

PHP Example

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://demo-api.gable.ai/v0/component/path-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 Example

package main

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

func main() {

url := "https://demo-api.gable.ai/v0/component/path-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))
}

Unirest Example

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

Ruby Example

require 'uri'
require 'net/http'

url = URI("https://demo-api.gable.ai/v0/component/path-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 Status Codes

• 200: Path diff retrieved successfully
• 400: Bad request
• 404: Not found
• 500: Server error

Metadata Object Structure

{
  "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 Object Structure

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

Common Error Responses

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