Create a canonical Pydantic model from field definitions

Create a canonical Pydantic model.

Accepts an explicit list of field definitions and returns:

The resolved field list
A JSON Schema representation
A Pydantic v2 Python class source string

Create a canonical Pydantic model. Accepts an explicit list of field definitions and returns: - The resolved field list - A JSON Schema representation - A Pydantic v2 Python class source string

Authentication

AuthorizationBearer

Static shared-secret token for internal service-to-service calls.

Request

This endpoint expects an object.

namestringRequired

Name of the canonical model (PascalCase)

fieldslist of objectsRequired

List of field definitions

descriptionstring or nullOptional

Model description

Response

Successful Response

namestring

descriptionstring or null

fieldslist of objects

json_schemamap from strings to any

Generated JSON Schema for the model

python_classstring

Generated Python Pydantic v2 class source code

Errors

422

Unprocessable Entity Error

$	curl -X POST https://host.com/api/v1/canonical/models \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "string",
>	"fields": [
>	{
>	"name": "string",
>	"type": "string"
>	}
>	]
>	}'

1	{
2	"name": "string",
3	"description": "string",
4	"fields": [
5	{
6	"name": "string",
7	"type": "string",
8	"description": "string",
9	"required": true,
10	"enum_values": [
11	"string"
12	]
13	}
14	],
15	"json_schema": {},
16	"python_class": "string"
17	}