Add path to component. - Gable Docs

Documentation Index

Fetch the complete documentation index at: /llms.txt

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

POST

/ v0

/experimental

/components

{id}

/paths

Try it

Add path to component.

cURL

curl --request POST \
  --url https://demo-api.gable.ai/v0/experimental/components/{id}/paths \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "ingress": {
    "signature_name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "kind": "<string>",
    "schema": {},
    "payload_name": "<string>",
    "description": "<string>"
  },
  "egress": {
    "signature_name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "kind": "<string>",
    "schema": {},
    "payload_name": "<string>",
    "description": "<string>"
  },
  "field_mappings": [
    {
      "ingress_field": "<string>",
      "egress_field": "<string>",
      "notes": "<string>"
    }
  ],
  "code_anchors": [
    {
      "anchor_id": "<string>",
      "name": "<string>",
      "file": "<string>",
      "line_start": 123,
      "line_end": 123,
      "column_start": 123,
      "column_end": 123,
      "url": "<string>"
    }
  ],
  "transformation_summary": "<string>",
  "payload_name": "<string>",
  "reason": "<string>",
  "effective_since_commit_sha": "<string>"
}
'

Python

import requests

url = "https://demo-api.gable.ai/v0/experimental/components/{id}/paths"

payload = {
    "ingress": {
        "signature_name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "kind": "<string>",
        "schema": {},
        "payload_name": "<string>",
        "description": "<string>"
    },
    "egress": {
        "signature_name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "kind": "<string>",
        "schema": {},
        "payload_name": "<string>",
        "description": "<string>"
    },
    "field_mappings": [
        {
            "ingress_field": "<string>",
            "egress_field": "<string>",
            "notes": "<string>"
        }
    ],
    "code_anchors": [
        {
            "anchor_id": "<string>",
            "name": "<string>",
            "file": "<string>",
            "line_start": 123,
            "line_end": 123,
            "column_start": 123,
            "column_end": 123,
            "url": "<string>"
        }
    ],
    "transformation_summary": "<string>",
    "payload_name": "<string>",
    "reason": "<string>",
    "effective_since_commit_sha": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ingress: {
      signature_name: '<string>',
      id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      kind: '<string>',
      schema: {},
      payload_name: '<string>',
      description: '<string>'
    },
    egress: {
      signature_name: '<string>',
      id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      kind: '<string>',
      schema: {},
      payload_name: '<string>',
      description: '<string>'
    },
    field_mappings: [{ingress_field: '<string>', egress_field: '<string>', notes: '<string>'}],
    code_anchors: [
      {
        anchor_id: '<string>',
        name: '<string>',
        file: '<string>',
        line_start: 123,
        line_end: 123,
        column_start: 123,
        column_end: 123,
        url: '<string>'
      }
    ],
    transformation_summary: '<string>',
    payload_name: '<string>',
    reason: '<string>',
    effective_since_commit_sha: '<string>'
  })
};

fetch('https://demo-api.gable.ai/v0/experimental/components/{id}/paths', 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/experimental/components/{id}/paths",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ingress' => [
        'signature_name' => '<string>',
        'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'kind' => '<string>',
        'schema' => [],
        'payload_name' => '<string>',
        'description' => '<string>'
    ],
    'egress' => [
        'signature_name' => '<string>',
        'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'kind' => '<string>',
        'schema' => [],
        'payload_name' => '<string>',
        'description' => '<string>'
    ],
    'field_mappings' => [
        [
                'ingress_field' => '<string>',
                'egress_field' => '<string>',
                'notes' => '<string>'
        ]
    ],
    'code_anchors' => [
        [
                'anchor_id' => '<string>',
                'name' => '<string>',
                'file' => '<string>',
                'line_start' => 123,
                'line_end' => 123,
                'column_start' => 123,
                'column_end' => 123,
                'url' => '<string>'
        ]
    ],
    'transformation_summary' => '<string>',
    'payload_name' => '<string>',
    'reason' => '<string>',
    'effective_since_commit_sha' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://demo-api.gable.ai/v0/experimental/components/{id}/paths"

payload := strings.NewReader("{\n  \"ingress\": {\n    \"signature_name\": \"<string>\",\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"kind\": \"<string>\",\n    \"schema\": {},\n    \"payload_name\": \"<string>\",\n    \"description\": \"<string>\"\n  },\n  \"egress\": {\n    \"signature_name\": \"<string>\",\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"kind\": \"<string>\",\n    \"schema\": {},\n    \"payload_name\": \"<string>\",\n    \"description\": \"<string>\"\n  },\n  \"field_mappings\": [\n    {\n      \"ingress_field\": \"<string>\",\n      \"egress_field\": \"<string>\",\n      \"notes\": \"<string>\"\n    }\n  ],\n  \"code_anchors\": [\n    {\n      \"anchor_id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"file\": \"<string>\",\n      \"line_start\": 123,\n      \"line_end\": 123,\n      \"column_start\": 123,\n      \"column_end\": 123,\n      \"url\": \"<string>\"\n    }\n  ],\n  \"transformation_summary\": \"<string>\",\n  \"payload_name\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"effective_since_commit_sha\": \"<string>\"}\n")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-KEY", "<api-key>")
    req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))
}

Response

Success

{
  "path": {
    "ingress": {
      "signature_name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "<string>",
      "schema": {},
      "payload_name": "<string>",
      "description": "<string>"
    },
    "egress": {
      "signature_name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "<string>",
      "schema": {},
      "payload_name": "<string>",
      "description": "<string>"
    },
    "path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_suppressed": false,
    "field_mappings": [
      {
        "ingress_field": "<string>",
        "egress_field": "<string>",
        "notes": "<string>"
      }
    ],
    "code_anchors": [
      {
        "anchor_id": "<string>",
        "name": "<string>",
        "file": "<string>",
        "line_start": 123,
        "line_end": 123,
        "column_start": 123,
        "column_end": 123,
        "url": "<string>"
      }
    ],
    "transformation_summary": "<string>",
    "payload_name": "<string>",
    "completeness": {}
  }
}

Error

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