lineage

List a component's multi-hop upstream and downstream dependencies.

EXPERIMENTAL. Walk connected strand edges from every enabled field mapping of one component, upstream from each ingress field and downstream from each egress field, up to maxHops hops, and return every component, payload and field reached as flat hop records. Only the components within maxHops edges of the start component are evaluated, each at its latest scan. A single walk that would cross a composition contract limit is dropped and reported through truncated instead of failing the read.

GET

experimental

component

{id}

discriminator_dependencies

List a component's multi-hop upstream and downstream dependencies.

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

import requests

url = "https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_dependencies"

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

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

print(response.text)

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_dependencies",
  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;
}

package main

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

func main() {

	url := "https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_dependencies"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_dependencies")

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

{
  "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "maxHops": 123,
  "truncated": true,
  "upstream": [
    {
      "hops": 2,
      "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "componentName": "<string>",
      "componentType": "CODE",
      "payload": {
        "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "level": "payload",
        "ancestors": [
          {
            "level": "payload",
            "coordinates": {}
          }
        ],
        "coordinates": {}
      },
      "groupId": "<string>",
      "matched": true,
      "fieldPath": "<string>",
      "edgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "suppressed": true,
      "startGroupId": "<string>",
      "startFieldPath": "<string>"
    }
  ],
  "downstream": [
    {
      "hops": 2,
      "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "componentName": "<string>",
      "componentType": "CODE",
      "payload": {
        "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "level": "payload",
        "ancestors": [
          {
            "level": "payload",
            "coordinates": {}
          }
        ],
        "coordinates": {}
      },
      "groupId": "<string>",
      "matched": true,
      "fieldPath": "<string>",
      "edgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "suppressed": true,
      "startGroupId": "<string>",
      "startFieldPath": "<string>"
    }
  ]
}

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

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

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

Authorizations

X-API-KEY

string

header

required

Path Parameters

string<uuid>

required

UUID of the component the walks start on.

Query Parameters

maxHops

integer

default:5

How many edges to follow from the component in each direction.

Required range: 1 <= x <= 5

Response

Every dependency reached within the hop budget.

A component's cross-service dependencies within a hop budget, as flat hop records. Consumers fold the records themselves: group by componentId for a per-component summary (nearest hop, distinct fields), by startGroupId for the dependencies of one payload group, and filter by hops for a tighter radius without another read.

componentId

string<uuid>

required

maxHops

integer

required

The hop budget the walks ran with.

truncated

boolean

required

At least one field's walk crossed a composition contract limit and was dropped, so the lists are incomplete for that field.

upstream

object[]

required

Every payload field the component's ingress fields come from, nearest hop first.

Show child attributes

downstream

object[]

required

Every payload field the component's egress fields flow to, nearest hop first.

Show child attributes

⌘I

List a component's multi-hop upstream and downstream dependencies.

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

import requests

url = "https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_dependencies"

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

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

print(response.text)

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_dependencies",
  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;
}

package main

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

func main() {

	url := "https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_dependencies"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_dependencies")

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

{
  "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "maxHops": 123,
  "truncated": true,
  "upstream": [
    {
      "hops": 2,
      "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "componentName": "<string>",
      "componentType": "CODE",
      "payload": {
        "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "level": "payload",
        "ancestors": [
          {
            "level": "payload",
            "coordinates": {}
          }
        ],
        "coordinates": {}
      },
      "groupId": "<string>",
      "matched": true,
      "fieldPath": "<string>",
      "edgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "suppressed": true,
      "startGroupId": "<string>",
      "startFieldPath": "<string>"
    }
  ],
  "downstream": [
    {
      "hops": 2,
      "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "componentName": "<string>",
      "componentType": "CODE",
      "payload": {
        "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "level": "payload",
        "ancestors": [
          {
            "level": "payload",
            "coordinates": {}
          }
        ],
        "coordinates": {}
      },
      "groupId": "<string>",
      "matched": true,
      "fieldPath": "<string>",
      "edgeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "suppressed": true,
      "startGroupId": "<string>",
      "startFieldPath": "<string>"
    }
  ]
}

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

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

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

Introduction

Gable

List a component's multi-hop upstream and downstream dependencies.

Authorizations

Path Parameters

Query Parameters

Response