Register an S3 data asset - 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/data-asset/register/s3

Register an S3 data asset

cURL

curl --request POST \
  --url https://demo-api.gable.ai/v0/data-asset/register/s3 \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "assets": [
    {
      "schema": {
        "type": "struct",
        "name": "<string>",
        "fields": [
          {
            "type": "struct",
            "name": "<string>",
            "fields": "<array>",
            "alias": "<string>",
            "doc": "<string>",
            "logical": "<string>",
            "optional": true
          }
        ],
        "alias": "<string>",
        "doc": "<string>",
        "logical": "<string>"
      },
      "pattern": "<string>",
      "bucket": "<string>",
      "fieldNameToDataAssetFieldProfileMap": {}
    }
  ],
  "dry_run": false,
  "prLink": "https://github.com/fakeorg/fakerepo/pull/123"
}
'

Python

import requests

url = "https://demo-api.gable.ai/v0/data-asset/register/s3"

payload = {
    "assets": [
        {
            "schema": {
                "type": "struct",
                "name": "<string>",
                "fields": [
                    {
                        "type": "struct",
                        "name": "<string>",
                        "fields": "<array>",
                        "alias": "<string>",
                        "doc": "<string>",
                        "logical": "<string>",
                        "optional": True
                    }
                ],
                "alias": "<string>",
                "doc": "<string>",
                "logical": "<string>"
            },
            "pattern": "<string>",
            "bucket": "<string>",
            "fieldNameToDataAssetFieldProfileMap": {}
        }
    ],
    "dry_run": False,
    "prLink": "https://github.com/fakeorg/fakerepo/pull/123"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    assets: [
      {
        schema: {
          type: 'struct',
          name: '<string>',
          fields: [
            {
              type: 'struct',
              name: '<string>',
              fields: '<array>',
              alias: '<string>',
              doc: '<string>',
              logical: '<string>',
              optional: true
            }
          ],
          alias: '<string>',
          doc: '<string>',
          logical: '<string>'
        },
        pattern: '<string>',
        bucket: '<string>',
        fieldNameToDataAssetFieldProfileMap: {}
      }
    ],
    dry_run: false,
    prLink: 'https://github.com/fakeorg/fakerepo/pull/123'
  })
};

fetch('https://demo-api.gable.ai/v0/data-asset/register/s3', 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://demo-api.gable.ai/v0/data-asset/register/s3",
  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([
    'assets' => [
        [
                'schema' => [
                                'type' => 'struct',
                                'name' => '<string>',
                                'fields' => [
                                                                [
                                                                                                                                'type' => 'struct',
                                                                                                                                'name' => '<string>',
                                                                                                                                'fields' => '<array>',
                                                                                                                                'alias' => '<string>',
                                                                                                                                'doc' => '<string>',
                                                                                                                                'logical' => '<string>',
                                                                                                                                'optional' => true
                                                                ]
                                ],
                                'alias' => '<string>',
                                'doc' => '<string>',
                                'logical' => '<string>'
                ],
                'pattern' => '<string>',
                'bucket' => '<string>',
                'fieldNameToDataAssetFieldProfileMap' => [

]
        ]
    ],
    'dry_run' => false,
    'prLink' => 'https://github.com/fakeorg/fakerepo/pull/123'
  ]),
  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/data-asset/register/s3"

payload := strings.NewReader("{\n  \"assets\": [\n    {\n      \"schema\": {\n        \"type\": \"struct\",\n        \"name\": \"<string>\",\n        \"fields\": [\n          {\n            \"type\": \"struct\",\n            \"name\": \"<string>\",\n            \"fields\": \"<array>\",\n            \"alias\": \"<string>\",\n            \"doc\": \"<string>\",\n            \"logical\": \"<string>\",\n            \"optional\": true\n          }\n        ],\n        \"alias\": \"<string>\",\n        \"doc\": \"<string>\",\n        \"logical\": \"<string>\"\n      },\n      \"pattern\": \"<string>\",\n      \"bucket\": \"<string>\",\n      \"fieldNameToDataAssetFieldProfileMap\": {}\n    }\n  ],\n  \"dry_run\": false,\n  \"prLink\": \"https://github.com/fakeorg/fakerepo/pull/123\"}")

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

Responses

200
{
  "message": "<string>",
  "registered": [
    "<string>"
  ],
  "success": true
}
400
{
  "message": "<string>",
  "id": 123,
  "title": "<string>",
  "success": true
}
500
{
  "message": "<string>",
  "id": 123,
  "title": "<string>",
  "success": true
}

Authorizations

X-API-KEY

Body