Validate a schema config
curl --request POST \
--url https://api.synthbrew.com/api/public/v1/schema-config/validate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"schema": {
"formatVersion": 1,
"entities": [
{
"id": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"nullable": false,
"generation": {
"emptyRate": 0,
"uniqueValues": true
},
"minLength": 1,
"maxLength": 2,
"min": 123,
"max": 123,
"precision": 2,
"prefix": "<string>",
"suffix": "<string>",
"trueRate": 0.5,
"weekdaysOnly": false,
"values": [
"<string>"
],
"weights": [
123
]
}
],
"label": "<string>",
"description": "<string>",
"primaryKey": [
"<string>"
],
"uniqueKeys": [
[
"<string>"
]
],
"indexes": [
{
"fields": [
"<string>"
],
"id": "<string>",
"unique": false
}
],
"generation": {
"rowCount": 1,
"locale": "<string>",
"timezone": "<string>",
"seed": "<string>"
}
}
],
"metadata": {
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
]
},
"generationDefaults": {
"rowCount": 1,
"locale": "<string>",
"timezone": "<string>",
"seed": "<string>"
}
},
"schemaConfigVersion": "v1"
}
'import requests
url = "https://api.synthbrew.com/api/public/v1/schema-config/validate"
payload = {
"schema": {
"formatVersion": 1,
"entities": [
{
"id": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"nullable": False,
"generation": {
"emptyRate": 0,
"uniqueValues": True
},
"minLength": 1,
"maxLength": 2,
"min": 123,
"max": 123,
"precision": 2,
"prefix": "<string>",
"suffix": "<string>",
"trueRate": 0.5,
"weekdaysOnly": False,
"values": ["<string>"],
"weights": [123]
}
],
"label": "<string>",
"description": "<string>",
"primaryKey": ["<string>"],
"uniqueKeys": [["<string>"]],
"indexes": [
{
"fields": ["<string>"],
"id": "<string>",
"unique": False
}
],
"generation": {
"rowCount": 1,
"locale": "<string>",
"timezone": "<string>",
"seed": "<string>"
}
}
],
"metadata": {
"name": "<string>",
"description": "<string>",
"tags": ["<string>"]
},
"generationDefaults": {
"rowCount": 1,
"locale": "<string>",
"timezone": "<string>",
"seed": "<string>"
}
},
"schemaConfigVersion": "v1"
}
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({
schema: {
formatVersion: 1,
entities: [
{
id: '<string>',
fields: [
{
id: '<string>',
label: '<string>',
description: '<string>',
nullable: false,
generation: {emptyRate: 0, uniqueValues: true},
minLength: 1,
maxLength: 2,
min: 123,
max: 123,
precision: 2,
prefix: '<string>',
suffix: '<string>',
trueRate: 0.5,
weekdaysOnly: false,
values: ['<string>'],
weights: [123]
}
],
label: '<string>',
description: '<string>',
primaryKey: ['<string>'],
uniqueKeys: [['<string>']],
indexes: [{fields: ['<string>'], id: '<string>', unique: false}],
generation: {rowCount: 1, locale: '<string>', timezone: '<string>', seed: '<string>'}
}
],
metadata: {name: '<string>', description: '<string>', tags: ['<string>']},
generationDefaults: {rowCount: 1, locale: '<string>', timezone: '<string>', seed: '<string>'}
},
schemaConfigVersion: 'v1'
})
};
fetch('https://api.synthbrew.com/api/public/v1/schema-config/validate', 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://api.synthbrew.com/api/public/v1/schema-config/validate",
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([
'schema' => [
'formatVersion' => 1,
'entities' => [
[
'id' => '<string>',
'fields' => [
[
'id' => '<string>',
'label' => '<string>',
'description' => '<string>',
'nullable' => false,
'generation' => [
'emptyRate' => 0,
'uniqueValues' => true
],
'minLength' => 1,
'maxLength' => 2,
'min' => 123,
'max' => 123,
'precision' => 2,
'prefix' => '<string>',
'suffix' => '<string>',
'trueRate' => 0.5,
'weekdaysOnly' => false,
'values' => [
'<string>'
],
'weights' => [
123
]
]
],
'label' => '<string>',
'description' => '<string>',
'primaryKey' => [
'<string>'
],
'uniqueKeys' => [
[
'<string>'
]
],
'indexes' => [
[
'fields' => [
'<string>'
],
'id' => '<string>',
'unique' => false
]
],
'generation' => [
'rowCount' => 1,
'locale' => '<string>',
'timezone' => '<string>',
'seed' => '<string>'
]
]
],
'metadata' => [
'name' => '<string>',
'description' => '<string>',
'tags' => [
'<string>'
]
],
'generationDefaults' => [
'rowCount' => 1,
'locale' => '<string>',
'timezone' => '<string>',
'seed' => '<string>'
]
],
'schemaConfigVersion' => 'v1'
]),
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://api.synthbrew.com/api/public/v1/schema-config/validate"
payload := strings.NewReader("{\n \"schema\": {\n \"formatVersion\": 1,\n \"entities\": [\n {\n \"id\": \"<string>\",\n \"fields\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"nullable\": false,\n \"generation\": {\n \"emptyRate\": 0,\n \"uniqueValues\": true\n },\n \"minLength\": 1,\n \"maxLength\": 2,\n \"min\": 123,\n \"max\": 123,\n \"precision\": 2,\n \"prefix\": \"<string>\",\n \"suffix\": \"<string>\",\n \"trueRate\": 0.5,\n \"weekdaysOnly\": false,\n \"values\": [\n \"<string>\"\n ],\n \"weights\": [\n 123\n ]\n }\n ],\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"primaryKey\": [\n \"<string>\"\n ],\n \"uniqueKeys\": [\n [\n \"<string>\"\n ]\n ],\n \"indexes\": [\n {\n \"fields\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"unique\": false\n }\n ],\n \"generation\": {\n \"rowCount\": 1,\n \"locale\": \"<string>\",\n \"timezone\": \"<string>\",\n \"seed\": \"<string>\"\n }\n }\n ],\n \"metadata\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"generationDefaults\": {\n \"rowCount\": 1,\n \"locale\": \"<string>\",\n \"timezone\": \"<string>\",\n \"seed\": \"<string>\"\n }\n },\n \"schemaConfigVersion\": \"v1\"\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://api.synthbrew.com/api/public/v1/schema-config/validate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"schema\": {\n \"formatVersion\": 1,\n \"entities\": [\n {\n \"id\": \"<string>\",\n \"fields\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"nullable\": false,\n \"generation\": {\n \"emptyRate\": 0,\n \"uniqueValues\": true\n },\n \"minLength\": 1,\n \"maxLength\": 2,\n \"min\": 123,\n \"max\": 123,\n \"precision\": 2,\n \"prefix\": \"<string>\",\n \"suffix\": \"<string>\",\n \"trueRate\": 0.5,\n \"weekdaysOnly\": false,\n \"values\": [\n \"<string>\"\n ],\n \"weights\": [\n 123\n ]\n }\n ],\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"primaryKey\": [\n \"<string>\"\n ],\n \"uniqueKeys\": [\n [\n \"<string>\"\n ]\n ],\n \"indexes\": [\n {\n \"fields\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"unique\": false\n }\n ],\n \"generation\": {\n \"rowCount\": 1,\n \"locale\": \"<string>\",\n \"timezone\": \"<string>\",\n \"seed\": \"<string>\"\n }\n }\n ],\n \"metadata\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"generationDefaults\": {\n \"rowCount\": 1,\n \"locale\": \"<string>\",\n \"timezone\": \"<string>\",\n \"seed\": \"<string>\"\n }\n },\n \"schemaConfigVersion\": \"v1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synthbrew.com/api/public/v1/schema-config/validate")
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 \"schema\": {\n \"formatVersion\": 1,\n \"entities\": [\n {\n \"id\": \"<string>\",\n \"fields\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"nullable\": false,\n \"generation\": {\n \"emptyRate\": 0,\n \"uniqueValues\": true\n },\n \"minLength\": 1,\n \"maxLength\": 2,\n \"min\": 123,\n \"max\": 123,\n \"precision\": 2,\n \"prefix\": \"<string>\",\n \"suffix\": \"<string>\",\n \"trueRate\": 0.5,\n \"weekdaysOnly\": false,\n \"values\": [\n \"<string>\"\n ],\n \"weights\": [\n 123\n ]\n }\n ],\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"primaryKey\": [\n \"<string>\"\n ],\n \"uniqueKeys\": [\n [\n \"<string>\"\n ]\n ],\n \"indexes\": [\n {\n \"fields\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"unique\": false\n }\n ],\n \"generation\": {\n \"rowCount\": 1,\n \"locale\": \"<string>\",\n \"timezone\": \"<string>\",\n \"seed\": \"<string>\"\n }\n }\n ],\n \"metadata\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"generationDefaults\": {\n \"rowCount\": 1,\n \"locale\": \"<string>\",\n \"timezone\": \"<string>\",\n \"seed\": \"<string>\"\n }\n },\n \"schemaConfigVersion\": \"v1\"\n}"
response = http.request(request)
puts response.read_body{
"schemaConfigVersion": "v1",
"valid": true,
"errors": [
{
"path": "entities.0.primaryKey.0",
"message": "Unknown field \"missing_id\" in entity \"orders\" primaryKey"
}
],
"suggestions": [
"<string>"
],
"schema": {
"formatVersion": 1,
"entities": [
{
"id": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"nullable": false,
"references": {
"entity": "<string>",
"field": "<string>",
"relation": "many-to-one",
"pick": "random",
"onDelete": "restrict",
"onUpdate": "restrict"
},
"generation": {
"emptyRate": 0,
"uniqueValues": true,
"strategy": {}
},
"minLength": 1,
"maxLength": 2,
"min": 123,
"max": 123,
"precision": 2,
"prefix": "<string>",
"suffix": "<string>",
"trueRate": 0.5,
"weekdaysOnly": false,
"values": [
"<string>"
],
"weights": [
123
]
}
],
"label": "<string>",
"description": "<string>",
"primaryKey": [
"<string>"
],
"uniqueKeys": [
[
"<string>"
]
],
"indexes": [
{
"fields": [
"<string>"
],
"id": "<string>",
"unique": false
}
],
"generation": {
"rowCount": 1,
"locale": "<string>",
"timezone": "<string>",
"seed": "<string>"
}
}
],
"metadata": {
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
]
},
"generationDefaults": {
"rowCount": 1,
"locale": "<string>",
"timezone": "<string>",
"seed": "<string>"
}
}
}
Schemas
Validate Schema Config
Validates a canonical Synthbrew schemaVersionConfig v1 without creating resources.
POST
/
public
/
v1
/
schema-config
/
validate
Validate a schema config
curl --request POST \
--url https://api.synthbrew.com/api/public/v1/schema-config/validate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"schema": {
"formatVersion": 1,
"entities": [
{
"id": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"nullable": false,
"generation": {
"emptyRate": 0,
"uniqueValues": true
},
"minLength": 1,
"maxLength": 2,
"min": 123,
"max": 123,
"precision": 2,
"prefix": "<string>",
"suffix": "<string>",
"trueRate": 0.5,
"weekdaysOnly": false,
"values": [
"<string>"
],
"weights": [
123
]
}
],
"label": "<string>",
"description": "<string>",
"primaryKey": [
"<string>"
],
"uniqueKeys": [
[
"<string>"
]
],
"indexes": [
{
"fields": [
"<string>"
],
"id": "<string>",
"unique": false
}
],
"generation": {
"rowCount": 1,
"locale": "<string>",
"timezone": "<string>",
"seed": "<string>"
}
}
],
"metadata": {
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
]
},
"generationDefaults": {
"rowCount": 1,
"locale": "<string>",
"timezone": "<string>",
"seed": "<string>"
}
},
"schemaConfigVersion": "v1"
}
'import requests
url = "https://api.synthbrew.com/api/public/v1/schema-config/validate"
payload = {
"schema": {
"formatVersion": 1,
"entities": [
{
"id": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"nullable": False,
"generation": {
"emptyRate": 0,
"uniqueValues": True
},
"minLength": 1,
"maxLength": 2,
"min": 123,
"max": 123,
"precision": 2,
"prefix": "<string>",
"suffix": "<string>",
"trueRate": 0.5,
"weekdaysOnly": False,
"values": ["<string>"],
"weights": [123]
}
],
"label": "<string>",
"description": "<string>",
"primaryKey": ["<string>"],
"uniqueKeys": [["<string>"]],
"indexes": [
{
"fields": ["<string>"],
"id": "<string>",
"unique": False
}
],
"generation": {
"rowCount": 1,
"locale": "<string>",
"timezone": "<string>",
"seed": "<string>"
}
}
],
"metadata": {
"name": "<string>",
"description": "<string>",
"tags": ["<string>"]
},
"generationDefaults": {
"rowCount": 1,
"locale": "<string>",
"timezone": "<string>",
"seed": "<string>"
}
},
"schemaConfigVersion": "v1"
}
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({
schema: {
formatVersion: 1,
entities: [
{
id: '<string>',
fields: [
{
id: '<string>',
label: '<string>',
description: '<string>',
nullable: false,
generation: {emptyRate: 0, uniqueValues: true},
minLength: 1,
maxLength: 2,
min: 123,
max: 123,
precision: 2,
prefix: '<string>',
suffix: '<string>',
trueRate: 0.5,
weekdaysOnly: false,
values: ['<string>'],
weights: [123]
}
],
label: '<string>',
description: '<string>',
primaryKey: ['<string>'],
uniqueKeys: [['<string>']],
indexes: [{fields: ['<string>'], id: '<string>', unique: false}],
generation: {rowCount: 1, locale: '<string>', timezone: '<string>', seed: '<string>'}
}
],
metadata: {name: '<string>', description: '<string>', tags: ['<string>']},
generationDefaults: {rowCount: 1, locale: '<string>', timezone: '<string>', seed: '<string>'}
},
schemaConfigVersion: 'v1'
})
};
fetch('https://api.synthbrew.com/api/public/v1/schema-config/validate', 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://api.synthbrew.com/api/public/v1/schema-config/validate",
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([
'schema' => [
'formatVersion' => 1,
'entities' => [
[
'id' => '<string>',
'fields' => [
[
'id' => '<string>',
'label' => '<string>',
'description' => '<string>',
'nullable' => false,
'generation' => [
'emptyRate' => 0,
'uniqueValues' => true
],
'minLength' => 1,
'maxLength' => 2,
'min' => 123,
'max' => 123,
'precision' => 2,
'prefix' => '<string>',
'suffix' => '<string>',
'trueRate' => 0.5,
'weekdaysOnly' => false,
'values' => [
'<string>'
],
'weights' => [
123
]
]
],
'label' => '<string>',
'description' => '<string>',
'primaryKey' => [
'<string>'
],
'uniqueKeys' => [
[
'<string>'
]
],
'indexes' => [
[
'fields' => [
'<string>'
],
'id' => '<string>',
'unique' => false
]
],
'generation' => [
'rowCount' => 1,
'locale' => '<string>',
'timezone' => '<string>',
'seed' => '<string>'
]
]
],
'metadata' => [
'name' => '<string>',
'description' => '<string>',
'tags' => [
'<string>'
]
],
'generationDefaults' => [
'rowCount' => 1,
'locale' => '<string>',
'timezone' => '<string>',
'seed' => '<string>'
]
],
'schemaConfigVersion' => 'v1'
]),
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://api.synthbrew.com/api/public/v1/schema-config/validate"
payload := strings.NewReader("{\n \"schema\": {\n \"formatVersion\": 1,\n \"entities\": [\n {\n \"id\": \"<string>\",\n \"fields\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"nullable\": false,\n \"generation\": {\n \"emptyRate\": 0,\n \"uniqueValues\": true\n },\n \"minLength\": 1,\n \"maxLength\": 2,\n \"min\": 123,\n \"max\": 123,\n \"precision\": 2,\n \"prefix\": \"<string>\",\n \"suffix\": \"<string>\",\n \"trueRate\": 0.5,\n \"weekdaysOnly\": false,\n \"values\": [\n \"<string>\"\n ],\n \"weights\": [\n 123\n ]\n }\n ],\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"primaryKey\": [\n \"<string>\"\n ],\n \"uniqueKeys\": [\n [\n \"<string>\"\n ]\n ],\n \"indexes\": [\n {\n \"fields\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"unique\": false\n }\n ],\n \"generation\": {\n \"rowCount\": 1,\n \"locale\": \"<string>\",\n \"timezone\": \"<string>\",\n \"seed\": \"<string>\"\n }\n }\n ],\n \"metadata\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"generationDefaults\": {\n \"rowCount\": 1,\n \"locale\": \"<string>\",\n \"timezone\": \"<string>\",\n \"seed\": \"<string>\"\n }\n },\n \"schemaConfigVersion\": \"v1\"\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://api.synthbrew.com/api/public/v1/schema-config/validate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"schema\": {\n \"formatVersion\": 1,\n \"entities\": [\n {\n \"id\": \"<string>\",\n \"fields\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"nullable\": false,\n \"generation\": {\n \"emptyRate\": 0,\n \"uniqueValues\": true\n },\n \"minLength\": 1,\n \"maxLength\": 2,\n \"min\": 123,\n \"max\": 123,\n \"precision\": 2,\n \"prefix\": \"<string>\",\n \"suffix\": \"<string>\",\n \"trueRate\": 0.5,\n \"weekdaysOnly\": false,\n \"values\": [\n \"<string>\"\n ],\n \"weights\": [\n 123\n ]\n }\n ],\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"primaryKey\": [\n \"<string>\"\n ],\n \"uniqueKeys\": [\n [\n \"<string>\"\n ]\n ],\n \"indexes\": [\n {\n \"fields\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"unique\": false\n }\n ],\n \"generation\": {\n \"rowCount\": 1,\n \"locale\": \"<string>\",\n \"timezone\": \"<string>\",\n \"seed\": \"<string>\"\n }\n }\n ],\n \"metadata\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"generationDefaults\": {\n \"rowCount\": 1,\n \"locale\": \"<string>\",\n \"timezone\": \"<string>\",\n \"seed\": \"<string>\"\n }\n },\n \"schemaConfigVersion\": \"v1\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synthbrew.com/api/public/v1/schema-config/validate")
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 \"schema\": {\n \"formatVersion\": 1,\n \"entities\": [\n {\n \"id\": \"<string>\",\n \"fields\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"nullable\": false,\n \"generation\": {\n \"emptyRate\": 0,\n \"uniqueValues\": true\n },\n \"minLength\": 1,\n \"maxLength\": 2,\n \"min\": 123,\n \"max\": 123,\n \"precision\": 2,\n \"prefix\": \"<string>\",\n \"suffix\": \"<string>\",\n \"trueRate\": 0.5,\n \"weekdaysOnly\": false,\n \"values\": [\n \"<string>\"\n ],\n \"weights\": [\n 123\n ]\n }\n ],\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"primaryKey\": [\n \"<string>\"\n ],\n \"uniqueKeys\": [\n [\n \"<string>\"\n ]\n ],\n \"indexes\": [\n {\n \"fields\": [\n \"<string>\"\n ],\n \"id\": \"<string>\",\n \"unique\": false\n }\n ],\n \"generation\": {\n \"rowCount\": 1,\n \"locale\": \"<string>\",\n \"timezone\": \"<string>\",\n \"seed\": \"<string>\"\n }\n }\n ],\n \"metadata\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n },\n \"generationDefaults\": {\n \"rowCount\": 1,\n \"locale\": \"<string>\",\n \"timezone\": \"<string>\",\n \"seed\": \"<string>\"\n }\n },\n \"schemaConfigVersion\": \"v1\"\n}"
response = http.request(request)
puts response.read_body{
"schemaConfigVersion": "v1",
"valid": true,
"errors": [
{
"path": "entities.0.primaryKey.0",
"message": "Unknown field \"missing_id\" in entity \"orders\" primaryKey"
}
],
"suggestions": [
"<string>"
],
"schema": {
"formatVersion": 1,
"entities": [
{
"id": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"nullable": false,
"references": {
"entity": "<string>",
"field": "<string>",
"relation": "many-to-one",
"pick": "random",
"onDelete": "restrict",
"onUpdate": "restrict"
},
"generation": {
"emptyRate": 0,
"uniqueValues": true,
"strategy": {}
},
"minLength": 1,
"maxLength": 2,
"min": 123,
"max": 123,
"precision": 2,
"prefix": "<string>",
"suffix": "<string>",
"trueRate": 0.5,
"weekdaysOnly": false,
"values": [
"<string>"
],
"weights": [
123
]
}
],
"label": "<string>",
"description": "<string>",
"primaryKey": [
"<string>"
],
"uniqueKeys": [
[
"<string>"
]
],
"indexes": [
{
"fields": [
"<string>"
],
"id": "<string>",
"unique": false
}
],
"generation": {
"rowCount": 1,
"locale": "<string>",
"timezone": "<string>",
"seed": "<string>"
}
}
],
"metadata": {
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
]
},
"generationDefaults": {
"rowCount": 1,
"locale": "<string>",
"timezone": "<string>",
"seed": "<string>"
}
}
}
This endpoint validates the frozen public schema config contract,
schemaConfigVersion: "v1".
The schema payload itself must use formatVersion: 1. Synthbrew may add optional fields, enum values, generation settings, and metadata fields to v1 without a new version. Synthbrew will not remove fields, rename fields, change existing meanings, or make optional fields required without introducing a new contract version.Authorizations
Team API key created under /api/api-keys. Prefix: sb_api_.
Body
application/json
Response
Validation result
Available options:
v1 Show child attributes
Show child attributes
Declarative schema config used by schema versions. This is the v1 public contract when paired with schemaConfigVersion="v1" and formatVersion=1.
Show child attributes
Show child attributes
⌘I