Create a new changelog event

POST

changelog

curl --request POST \
  --url https://{hostname}.gable.ai/v0/changelog \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractVersion": "<string>",
  "contractFieldName": "<string>",
  "entityType": "DATA_CONTRACT",
  "dataAssetResourceName": "<string>",
  "expectedValue": "<string>",
  "actualValue": "<string>",
  "contractName": "<string>",
  "contractDomain": "<string>",
  "dataAssetFieldProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eventType": "VIOLATION",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prLink": "<string>"
}
'

import requests

url = "https://{hostname}.gable.ai/v0/changelog"

payload = {
    "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contractVersion": "<string>",
    "contractFieldName": "<string>",
    "entityType": "DATA_CONTRACT",
    "dataAssetResourceName": "<string>",
    "expectedValue": "<string>",
    "actualValue": "<string>",
    "contractName": "<string>",
    "contractDomain": "<string>",
    "dataAssetFieldProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "eventType": "VIOLATION",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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({
    contractId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    contractVersion: '<string>',
    contractFieldName: '<string>',
    entityType: 'DATA_CONTRACT',
    dataAssetResourceName: '<string>',
    expectedValue: '<string>',
    actualValue: '<string>',
    contractName: '<string>',
    contractDomain: '<string>',
    dataAssetFieldProfileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    eventType: 'VIOLATION',
    userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    prLink: '<string>'
  })
};

fetch('https://{hostname}.gable.ai/v0/changelog', 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/changelog",
  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([
    'contractId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'contractVersion' => '<string>',
    'contractFieldName' => '<string>',
    'entityType' => 'DATA_CONTRACT',
    'dataAssetResourceName' => '<string>',
    'expectedValue' => '<string>',
    'actualValue' => '<string>',
    'contractName' => '<string>',
    'contractDomain' => '<string>',
    'dataAssetFieldProfileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'eventType' => 'VIOLATION',
    'userId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    '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/changelog"

	payload := strings.NewReader("{\n  \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contractVersion\": \"<string>\",\n  \"contractFieldName\": \"<string>\",\n  \"entityType\": \"DATA_CONTRACT\",\n  \"dataAssetResourceName\": \"<string>\",\n  \"expectedValue\": \"<string>\",\n  \"actualValue\": \"<string>\",\n  \"contractName\": \"<string>\",\n  \"contractDomain\": \"<string>\",\n  \"dataAssetFieldProfileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"eventType\": \"VIOLATION\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\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/changelog")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contractVersion\": \"<string>\",\n  \"contractFieldName\": \"<string>\",\n  \"entityType\": \"DATA_CONTRACT\",\n  \"dataAssetResourceName\": \"<string>\",\n  \"expectedValue\": \"<string>\",\n  \"actualValue\": \"<string>\",\n  \"contractName\": \"<string>\",\n  \"contractDomain\": \"<string>\",\n  \"dataAssetFieldProfileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"eventType\": \"VIOLATION\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"prLink\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/changelog")

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  \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contractVersion\": \"<string>\",\n  \"contractFieldName\": \"<string>\",\n  \"entityType\": \"DATA_CONTRACT\",\n  \"dataAssetResourceName\": \"<string>\",\n  \"expectedValue\": \"<string>\",\n  \"actualValue\": \"<string>\",\n  \"contractName\": \"<string>\",\n  \"contractDomain\": \"<string>\",\n  \"dataAssetFieldProfileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"eventType\": \"VIOLATION\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"prLink\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "changelogEventIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

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

Authorizations

X-API-KEY

string

header

required

Body

application/json

Changelog event to create

object
object[]

contractId

string<uuid>

required

Unique identifier for the contract in UUID format

contractVersion

string

required

Version of the contract

contractFieldName

string

required

Field of the contract where violation occured

entityType

enum<string>

required

The type of entity that the changelog event is associated with.

Available options:

DATA_CONTRACT

violationType

enum<string>

required

Type of violation

Available options:

MISSING_REQUIRED_PROPERTY,

INCOMPATIBLE_TYPE,

GREATER_THAN,

GREATER_THAN_OR_EQUAL_TO,

LESS_THAN,

LESS_THAN_OR_EQUAL_TO,

IS_NULL,

IS_NULL_THRESHOLD,

IS_NOT_EMPTY,

LENGTH,

LENGTH_GREATER_THAN,

LENGTH_GREATER_THAN_OR_EQUAL_TO,

LENGTH_LESS_THAN,

LENGTH_LESS_THAN_OR_EQUAL_TO,

MISSING_DATA_ASSET,

PII_DETECTED

dataAssetResourceName

string

required

The unique identifier of the data asset. It follows the pattern '{data_asset_type}://{data_asset_source}:{data_asset_name}'

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 _\./-\{\}\-]+$

expectedValue

string

required

Expected value of the field

actualValue

string

required

actual value of the field

contractName

string

Name of the contract

contractDomain

string

Domain of the contract

dataAssetFieldProfileId

string<uuid>

Unique identifier for the data asset field in UUID format

eventType

enum<string>

The type of event that occurred

Available options:

VIOLATION

userId

string<uuid>

Unique identifier for the user in UUID format

prLink

string

Link to the pull request associated with the violation

Response

Changelog event(s) was successfully created

changelogEventIds

string<uuid>[]

required

List of changelog event IDs that were create

Get changelog countGet changelog count

⌘I

Create a new changelog event

curl --request POST \
  --url https://{hostname}.gable.ai/v0/changelog \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractVersion": "<string>",
  "contractFieldName": "<string>",
  "entityType": "DATA_CONTRACT",
  "dataAssetResourceName": "<string>",
  "expectedValue": "<string>",
  "actualValue": "<string>",
  "contractName": "<string>",
  "contractDomain": "<string>",
  "dataAssetFieldProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eventType": "VIOLATION",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "prLink": "<string>"
}
'

import requests

url = "https://{hostname}.gable.ai/v0/changelog"

payload = {
    "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contractVersion": "<string>",
    "contractFieldName": "<string>",
    "entityType": "DATA_CONTRACT",
    "dataAssetResourceName": "<string>",
    "expectedValue": "<string>",
    "actualValue": "<string>",
    "contractName": "<string>",
    "contractDomain": "<string>",
    "dataAssetFieldProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "eventType": "VIOLATION",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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({
    contractId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    contractVersion: '<string>',
    contractFieldName: '<string>',
    entityType: 'DATA_CONTRACT',
    dataAssetResourceName: '<string>',
    expectedValue: '<string>',
    actualValue: '<string>',
    contractName: '<string>',
    contractDomain: '<string>',
    dataAssetFieldProfileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    eventType: 'VIOLATION',
    userId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    prLink: '<string>'
  })
};

fetch('https://{hostname}.gable.ai/v0/changelog', 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/changelog",
  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([
    'contractId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'contractVersion' => '<string>',
    'contractFieldName' => '<string>',
    'entityType' => 'DATA_CONTRACT',
    'dataAssetResourceName' => '<string>',
    'expectedValue' => '<string>',
    'actualValue' => '<string>',
    'contractName' => '<string>',
    'contractDomain' => '<string>',
    'dataAssetFieldProfileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'eventType' => 'VIOLATION',
    'userId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    '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/changelog"

	payload := strings.NewReader("{\n  \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contractVersion\": \"<string>\",\n  \"contractFieldName\": \"<string>\",\n  \"entityType\": \"DATA_CONTRACT\",\n  \"dataAssetResourceName\": \"<string>\",\n  \"expectedValue\": \"<string>\",\n  \"actualValue\": \"<string>\",\n  \"contractName\": \"<string>\",\n  \"contractDomain\": \"<string>\",\n  \"dataAssetFieldProfileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"eventType\": \"VIOLATION\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\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/changelog")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contractVersion\": \"<string>\",\n  \"contractFieldName\": \"<string>\",\n  \"entityType\": \"DATA_CONTRACT\",\n  \"dataAssetResourceName\": \"<string>\",\n  \"expectedValue\": \"<string>\",\n  \"actualValue\": \"<string>\",\n  \"contractName\": \"<string>\",\n  \"contractDomain\": \"<string>\",\n  \"dataAssetFieldProfileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"eventType\": \"VIOLATION\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"prLink\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/changelog")

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  \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contractVersion\": \"<string>\",\n  \"contractFieldName\": \"<string>\",\n  \"entityType\": \"DATA_CONTRACT\",\n  \"dataAssetResourceName\": \"<string>\",\n  \"expectedValue\": \"<string>\",\n  \"actualValue\": \"<string>\",\n  \"contractName\": \"<string>\",\n  \"contractDomain\": \"<string>\",\n  \"dataAssetFieldProfileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"eventType\": \"VIOLATION\",\n  \"userId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"prLink\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "changelogEventIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

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

Introduction

Gable

Create a new changelog event

Authorizations

Body

Response