Check list of data assets for contract violations - Gable Docs

Documentation Index

Fetch the complete documentation index at: /llms.txt

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

Check list of data assets for contract violations

cURL

curl --request POST \
  --url https://demo-api.gable.ai/v0/data-assets/check-compliance \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "assets": [
    {
      "data_asset_resource_name": {
        "data_source": "<string>",
        "path": "<string>"
      },
      "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>"
      },
      "fieldNameToDataAssetFieldProfileMap": {}
    }
  ],
  "includeUnchangedAssets": false,
  "prLink": "<string>"
}
'```

#### Payload Structure

```json
{
  "assets": [
    {
      "data_asset_resource_name": {
        "data_source": "<string>",
        "path": "<string>"
      },
      "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>"
      },
      "fieldNameToDataAssetFieldProfileMap": {}
    }
  ],
  "includeUnchangedAssets": false,
  "prLink": "<string>"
}

Authorizations

Header:

• X-API-KEY: required

Response Codes

• 200: Successful operation
• 400: Bad request
• 404: Not found
• 500: Internal server error

Example Response

[
  {
    "dataAssetNamespace": "<string>",
    "dataAssetResourceName": "<string>",
    "dataAssetPath": "<string>",
    "responseType": "NO_CONTRACT"
  }
]

Error Message Response

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