Introduction
Gable
- POSTCheck if the asset associated with the contract is compliant
- POSTCheck multiple assets for contract compliance
- GETGet all data assets
- POSTCreates or updates data assets
- DELDeletes data assets
- GETGet data assets by a list of DARNs
- GETGet data assets count
- POSTCreate a data asset
- POSTCheck list of data assets for contract violations
- POSTCheck list of data assets for contract violations
- POSTCheck list of S3 data assets for contract violations
- POSTIngest a data asset from a schema
- POSTRegister data assets
- POSTRegister an S3 data asset
- GETGet a data asset by id
- DELDelete a data asset by id
- GETInfer a contract from a data asset
- POSTCreate profile for a data asset
- POSTRegister sca metadata for a data asset version
- POST
Register data assets
Register data assets
curl --request POST \
--url https://{hostname}.gable.ai/v0/data-assets/register \
--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": "<array>",
"alias": "<string>",
"doc": "<string>",
"logical": "<string>",
"optional": true
}
],
"alias": "<string>",
"doc": "<string>",
"logical": "<string>"
},
"fieldNameToDataAssetFieldProfileMap": {}
}
],
"prLink": "https://github.com/fakeorg/fakerepo/pull/123"
}
'{
"asset_registration_outcomes": [
{
"data_asset_resource_name": {
"source_type": "postgres",
"data_source": "<string>",
"path": "<string>"
},
"error": "<string>"
}
]
}Authorizations
Body
Data Assets Registration Request
Array of data assets to register
Show child attributes
Show child attributes
The type of the source data asset, indicating its source or format (e.g., postgres, protobuf).
postgres, mysql, mssql, json_schema, avro, protobuf, python, pyspark, typescript, java, s3, dataframe, kotlin, swift, php, golang Show child attributes
Show child attributes
The type of the source data asset, indicating its source or format (e.g., postgres, protobuf).
postgres, mysql, mssql, json_schema, avro, protobuf, python, pyspark, typescript, java, s3, dataframe, kotlin, swift, php, golang The schema of the data asset
Show child attributes
Show child attributes
struct - Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
A mapping of the field name within the schema to its corresponding data profile
Show child attributes
Show child attributes
generic data asset field profile Data asset field profile for boolean
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
Show child attributes
Show child attributes
Number of samples
Whether the data is nullable
List of sampled files
1The parameters used to sample the data
Show child attributes
Show child attributes
boolean Number of true values
Number of false values
Unique identifier for the data asset field profile in UUID format
Number of nulls (only defined if nullable is true)
The date the sample was taken
Link to the PR that may have added or edited the data assets
"https://github.com/fakeorg/fakerepo/pull/123"
Response
Data Assets Registration Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The type of the source data asset, indicating its source or format (e.g., postgres, protobuf).
postgres, mysql, mssql, json_schema, avro, protobuf, python, pyspark, typescript, java, s3, dataframe, kotlin, swift, php, golang Error message if registration of this asset failed
curl --request POST \
--url https://{hostname}.gable.ai/v0/data-assets/register \
--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": "<array>",
"alias": "<string>",
"doc": "<string>",
"logical": "<string>",
"optional": true
}
],
"alias": "<string>",
"doc": "<string>",
"logical": "<string>"
},
"fieldNameToDataAssetFieldProfileMap": {}
}
],
"prLink": "https://github.com/fakeorg/fakerepo/pull/123"
}
'{
"asset_registration_outcomes": [
{
"data_asset_resource_name": {
"source_type": "postgres",
"data_source": "<string>",
"path": "<string>"
},
"error": "<string>"
}
]
}