data-asset
Check list of S3 data assets for contract violations
Check list of S3 data assets for contract violations
POST
/
v0
/
data-assets
/
check-compliance
/
s3
Check list of S3 data assets for contract violations
curl --request POST \
--url https://{hostname}.gable.ai/v0/data-assets/check-compliance/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": {}
}
],
"includeUnchangedAssets": false,
"prLink": "<string>"
}
'import requests
url = "https://{hostname}.gable.ai/v0/data-assets/check-compliance/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": {}
}
],
"includeUnchangedAssets": False,
"prLink": "<string>"
}
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({
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: {}
}
],
includeUnchangedAssets: false,
prLink: '<string>'
})
};
fetch('https://{hostname}.gable.ai/v0/data-assets/check-compliance/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://{hostname}.gable.ai/v0/data-assets/check-compliance/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' => [
]
]
],
'includeUnchangedAssets' => false,
'prLink' => '<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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{hostname}.gable.ai/v0/data-assets/check-compliance/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 \"includeUnchangedAssets\": false,\n \"prLink\": \"<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))
}HttpResponse<String> response = Unirest.post("https://{hostname}.gable.ai/v0/data-assets/check-compliance/s3")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\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 \"includeUnchangedAssets\": false,\n \"prLink\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{hostname}.gable.ai/v0/data-assets/check-compliance/s3")
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 \"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 \"includeUnchangedAssets\": false,\n \"prLink\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body[
{
"dataAssetNamespace": "<string>",
"dataAssetResourceName": "<string>",
"dataAssetPath": "<string>",
"responseType": "NO_CONTRACT"
}
]{
"message": "<string>",
"id": 123,
"title": "<string>"
}{
"message": "<string>",
"id": 123,
"title": "<string>"
}{
"message": "<string>",
"id": 123,
"title": "<string>"
}Authorizations
Body
application/json
List of S3 data assets to check for compliance
Array of data assets to check for compliance
Show child attributes
Show child attributes
Determines the format of the response from the API. Specifying 'DETAILED' will return a detailed JSON object for each data asset checked. If 'COMMENT_MARKDOWN' is specified, the response will be a markdown string intended to be used as a comment in a pull request.
Available options:
DETAILED, COMMENT_MARKDOWN If true, the data assets sent that have not changed compared with the stored assets will be checked for contract violations and responseType: NO_CHANGE will be returned for those assets. If false, the only data assets that have changed compared with the stored assets will be checked for contract violations.
Link to the pull request the proposed changes to the data asset are part of
Response
Data Asset ID
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
The namespace of the data asset
Examples:
"postgres://service-one.aaa.eu-west-1.rds.amazonaws.com:5432"
"protobuf://github.com/org/repo/path/to/file.proto"
The full resource name of the data asset, see Data Assets
Pattern:
^(protobuf|avro|json_schema|java|postgres|mysql|mssql|snowflake|bigquery|python|pyspark|typescript|s3|dataframe|kotlin|swift|php)://(?=.*[a-zA-Z0-9])[a-zA-Z0-9_@\.:/-]+[:/](?=.*[a-zA-Z0-9])[a-zA-Z0-9 _\./-\{\}\-]+$Examples:
"postgres://service-one.aaa.eu-west-1.rds.amazonaws.com:5432:serviceone.public.sales"
"protobuf://git@github.com/org/repo/path/to/file.proto:company.serviceone.Sales"
The relative path of the data asset within its data store
Examples:
"serviceone.public.sales"
"company.serviceone.Sales"
Available options:
NO_CONTRACT ⌘I
Check list of S3 data assets for contract violations
curl --request POST \
--url https://{hostname}.gable.ai/v0/data-assets/check-compliance/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": {}
}
],
"includeUnchangedAssets": false,
"prLink": "<string>"
}
'import requests
url = "https://{hostname}.gable.ai/v0/data-assets/check-compliance/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": {}
}
],
"includeUnchangedAssets": False,
"prLink": "<string>"
}
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({
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: {}
}
],
includeUnchangedAssets: false,
prLink: '<string>'
})
};
fetch('https://{hostname}.gable.ai/v0/data-assets/check-compliance/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://{hostname}.gable.ai/v0/data-assets/check-compliance/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' => [
]
]
],
'includeUnchangedAssets' => false,
'prLink' => '<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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{hostname}.gable.ai/v0/data-assets/check-compliance/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 \"includeUnchangedAssets\": false,\n \"prLink\": \"<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))
}HttpResponse<String> response = Unirest.post("https://{hostname}.gable.ai/v0/data-assets/check-compliance/s3")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\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 \"includeUnchangedAssets\": false,\n \"prLink\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{hostname}.gable.ai/v0/data-assets/check-compliance/s3")
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 \"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 \"includeUnchangedAssets\": false,\n \"prLink\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body[
{
"dataAssetNamespace": "<string>",
"dataAssetResourceName": "<string>",
"dataAssetPath": "<string>",
"responseType": "NO_CONTRACT"
}
]{
"message": "<string>",
"id": 123,
"title": "<string>"
}{
"message": "<string>",
"id": 123,
"title": "<string>"
}{
"message": "<string>",
"id": 123,
"title": "<string>"
}