Skip to main content
POST
/
v0
/
data-assets
/
check-compliance
Check list of data assets for contract violations
curl --request POST \
  --url https://{hostname}.gable.ai/v0/data-assets/check-compliance \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "assets": [
    {
      "source_type": "postgres",
      "data_asset_resource_name": {
        "source_type": "postgres",
        "data_source": "<string>",
        "path": "<string>"
      },
      "schema": {
        "type": "struct",
        "name": "<string>",
        "fields": [
          {
            "type": "struct",
            "name": "<string>",
            "fields": [
              "<any>"
            ],
            "alias": "<string>",
            "doc": "<string>",
            "logical": "<string>",
            "optional": true
          }
        ],
        "alias": "<string>",
        "doc": "<string>",
        "logical": "<string>"
      },
      "fieldNameToDataAssetFieldProfileMap": {}
    }
  ],
  "includeUnchangedAssets": false,
  "responseType": "DETAILED",
  "prLink": "<string>"
}'
[
  {
    "dataAssetNamespace": "postgres://service-one.aaa.eu-west-1.rds.amazonaws.com:5432",
    "dataAssetResourceName": "postgres://service-one.aaa.eu-west-1.rds.amazonaws.com:5432:serviceone.public.sales",
    "dataAssetPath": "serviceone.public.sales",
    "responseType": "NO_CONTRACT"
  }
]

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
assets
object[]
required
​
responseType
enum<string>
required
Available options:
DETAILED,
COMMENT_MARKDOWN
​
includeUnchangedAssets
boolean
default:false
​
prLink
string

Response

  • object[]
  • object
  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
​
dataAssetNamespace
string
required
Examples:
​
dataAssetResourceName
string
required
​
dataAssetPath
string
required
Examples:
​
responseType
enum<string>
required
Available options:
NO_CONTRACT