lineage
Create a data store component.
EXPERIMENTAL. Create a data store component in the component registry with its schema recorded as the first versioned snapshot. Returns the same detail resource as the component read.
POST
/
v0
/
experimental
/
components
Create a data store component.
curl --request POST \
--url https://{hostname}.gable.ai/v0/experimental/components \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"type": "DATA_STORE",
"name": "<string>",
"schema": {
"fields": [
{
"name": "<string>",
"type": "<string>"
}
]
},
"friendly_name": "<string>",
"namespace": "<string>",
"metadata": {}
}
'import requests
url = "https://{hostname}.gable.ai/v0/experimental/components"
payload = {
"type": "DATA_STORE",
"name": "<string>",
"schema": { "fields": [
{
"name": "<string>",
"type": "<string>"
}
] },
"friendly_name": "<string>",
"namespace": "<string>",
"metadata": {}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'DATA_STORE',
name: '<string>',
schema: {fields: [{name: '<string>', type: '<string>'}]},
friendly_name: '<string>',
namespace: '<string>',
metadata: {}
})
};
fetch('https://{hostname}.gable.ai/v0/experimental/components', 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/components",
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([
'type' => 'DATA_STORE',
'name' => '<string>',
'schema' => [
'fields' => [
[
'name' => '<string>',
'type' => '<string>'
]
]
],
'friendly_name' => '<string>',
'namespace' => '<string>',
'metadata' => [
]
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{hostname}.gable.ai/v0/experimental/components"
payload := strings.NewReader("{\n \"type\": \"DATA_STORE\",\n \"name\": \"<string>\",\n \"schema\": {\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n },\n \"friendly_name\": \"<string>\",\n \"namespace\": \"<string>\",\n \"metadata\": {}\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))
}HttpResponse<String> response = Unirest.post("https://{hostname}.gable.ai/v0/experimental/components")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"DATA_STORE\",\n \"name\": \"<string>\",\n \"schema\": {\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n },\n \"friendly_name\": \"<string>\",\n \"namespace\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{hostname}.gable.ai/v0/experimental/components")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"DATA_STORE\",\n \"name\": \"<string>\",\n \"schema\": {\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n },\n \"friendly_name\": \"<string>\",\n \"namespace\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"component": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "CODE",
"namespace": "<string>",
"friendly_name": "<string>",
"paths": [
{
"ingress": {
"signature_name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "<string>",
"schema": {},
"payload_name": "<string>",
"description": "<string>",
"boundary_coordinates": {
"payload_name": null,
"signature_name": "OrdersController.create"
},
"field_tags": [
{
"field_path": "<string>",
"tags": [
{
"tag_id": "<string>",
"name": "<string>",
"kind": "SYSTEM",
"source": "system",
"color": "<string>",
"detection_category": "<string>"
}
]
}
],
"field_depends_on_tags": [
{
"field_path": "<string>",
"depends_on": [
{
"tag_id": "<string>",
"name": "<string>",
"kind": "SYSTEM",
"nearest_hops": 123,
"color": "<string>"
}
]
}
]
},
"egress": {
"signature_name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "<string>",
"schema": {},
"payload_name": "<string>",
"description": "<string>",
"boundary_coordinates": {
"payload_name": null,
"signature_name": "OrdersController.create"
},
"field_tags": [
{
"field_path": "<string>",
"tags": [
{
"tag_id": "<string>",
"name": "<string>",
"kind": "SYSTEM",
"source": "system",
"color": "<string>",
"detection_category": "<string>"
}
]
}
],
"field_depends_on_tags": [
{
"field_path": "<string>",
"depends_on": [
{
"tag_id": "<string>",
"name": "<string>",
"kind": "SYSTEM",
"nearest_hops": 123,
"color": "<string>"
}
]
}
]
},
"path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path_type": "SCAN_OUTPUT",
"is_suppressed": false,
"field_mappings": [
{
"ingress_field": "<string>",
"egress_field": "<string>",
"notes": "<string>",
"kind": "DataFlow"
}
],
"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": {
"ingress": "UNKNOWN",
"ingress_schema": "UNKNOWN",
"egress": "UNKNOWN",
"egress_schema": "UNKNOWN",
"field_mappings": "UNKNOWN"
}
}
],
"approval": {
"status": "UNAPPROVED",
"approvalEventId": "<string>",
"approvedAt": "2023-11-07T05:31:56Z",
"approvedBy": {
"userId": "<string>",
"email": "<string>",
"name": "<string>"
},
"note": "<string>"
},
"store_kind": "dynamodb",
"schema": {
"fields": [
{
"name": "<string>",
"type": "<string>"
}
]
},
"metadata": {}
}
}{
"message": "<string>",
"id": 123,
"title": "<string>"
}{
"message": "<string>",
"id": 123,
"title": "<string>"
}Authorizations
Body
application/json
EXPERIMENTAL. Register a data store component directly in the component registry, with its schema as the first versioned snapshot. The store becomes addressable as a discriminator edge endpoint immediately; no scan pipeline is involved.
Only DATA_STORE components can be created through this endpoint.
Available options:
DATA_STORE The store's canonical name (table, topic, index), used as its payload name on edges.
Minimum string length:
1Storage technology type.
Available options:
dynamodb, redis, elasticache, database, kafka, other Show child attributes
Show child attributes
Optional display name.
The namespace the component belongs to.
Free-form registry metadata.
Show child attributes
Show child attributes
Response
Component created.
Full component detail with paths in self-contained (round-trip) format. For CODE components, paths include inline ingress/egress boundary data. For DATA_STORE components, the schema field list is included.
Show child attributes
Show child attributes
⌘I
Create a data store component.
curl --request POST \
--url https://{hostname}.gable.ai/v0/experimental/components \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"type": "DATA_STORE",
"name": "<string>",
"schema": {
"fields": [
{
"name": "<string>",
"type": "<string>"
}
]
},
"friendly_name": "<string>",
"namespace": "<string>",
"metadata": {}
}
'import requests
url = "https://{hostname}.gable.ai/v0/experimental/components"
payload = {
"type": "DATA_STORE",
"name": "<string>",
"schema": { "fields": [
{
"name": "<string>",
"type": "<string>"
}
] },
"friendly_name": "<string>",
"namespace": "<string>",
"metadata": {}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'DATA_STORE',
name: '<string>',
schema: {fields: [{name: '<string>', type: '<string>'}]},
friendly_name: '<string>',
namespace: '<string>',
metadata: {}
})
};
fetch('https://{hostname}.gable.ai/v0/experimental/components', 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/components",
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([
'type' => 'DATA_STORE',
'name' => '<string>',
'schema' => [
'fields' => [
[
'name' => '<string>',
'type' => '<string>'
]
]
],
'friendly_name' => '<string>',
'namespace' => '<string>',
'metadata' => [
]
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{hostname}.gable.ai/v0/experimental/components"
payload := strings.NewReader("{\n \"type\": \"DATA_STORE\",\n \"name\": \"<string>\",\n \"schema\": {\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n },\n \"friendly_name\": \"<string>\",\n \"namespace\": \"<string>\",\n \"metadata\": {}\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))
}HttpResponse<String> response = Unirest.post("https://{hostname}.gable.ai/v0/experimental/components")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"DATA_STORE\",\n \"name\": \"<string>\",\n \"schema\": {\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n },\n \"friendly_name\": \"<string>\",\n \"namespace\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{hostname}.gable.ai/v0/experimental/components")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"DATA_STORE\",\n \"name\": \"<string>\",\n \"schema\": {\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n },\n \"friendly_name\": \"<string>\",\n \"namespace\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"component": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "CODE",
"namespace": "<string>",
"friendly_name": "<string>",
"paths": [
{
"ingress": {
"signature_name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "<string>",
"schema": {},
"payload_name": "<string>",
"description": "<string>",
"boundary_coordinates": {
"payload_name": null,
"signature_name": "OrdersController.create"
},
"field_tags": [
{
"field_path": "<string>",
"tags": [
{
"tag_id": "<string>",
"name": "<string>",
"kind": "SYSTEM",
"source": "system",
"color": "<string>",
"detection_category": "<string>"
}
]
}
],
"field_depends_on_tags": [
{
"field_path": "<string>",
"depends_on": [
{
"tag_id": "<string>",
"name": "<string>",
"kind": "SYSTEM",
"nearest_hops": 123,
"color": "<string>"
}
]
}
]
},
"egress": {
"signature_name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "<string>",
"schema": {},
"payload_name": "<string>",
"description": "<string>",
"boundary_coordinates": {
"payload_name": null,
"signature_name": "OrdersController.create"
},
"field_tags": [
{
"field_path": "<string>",
"tags": [
{
"tag_id": "<string>",
"name": "<string>",
"kind": "SYSTEM",
"source": "system",
"color": "<string>",
"detection_category": "<string>"
}
]
}
],
"field_depends_on_tags": [
{
"field_path": "<string>",
"depends_on": [
{
"tag_id": "<string>",
"name": "<string>",
"kind": "SYSTEM",
"nearest_hops": 123,
"color": "<string>"
}
]
}
]
},
"path_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path_type": "SCAN_OUTPUT",
"is_suppressed": false,
"field_mappings": [
{
"ingress_field": "<string>",
"egress_field": "<string>",
"notes": "<string>",
"kind": "DataFlow"
}
],
"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": {
"ingress": "UNKNOWN",
"ingress_schema": "UNKNOWN",
"egress": "UNKNOWN",
"egress_schema": "UNKNOWN",
"field_mappings": "UNKNOWN"
}
}
],
"approval": {
"status": "UNAPPROVED",
"approvalEventId": "<string>",
"approvedAt": "2023-11-07T05:31:56Z",
"approvedBy": {
"userId": "<string>",
"email": "<string>",
"name": "<string>"
},
"note": "<string>"
},
"store_kind": "dynamodb",
"schema": {
"fields": [
{
"name": "<string>",
"type": "<string>"
}
]
},
"metadata": {}
}
}{
"message": "<string>",
"id": 123,
"title": "<string>"
}{
"message": "<string>",
"id": 123,
"title": "<string>"
}