Schemas endpoints

This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.

GET /api/projects/{projectId}/schemas

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
cursor	query	string	no
limit	query	integer (int32) or string (int32)	no

Status	Meaning	Body
200	OK	none

POST /api/projects/{projectId}/schemas

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Request body (application/json): CreateSchemaRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
description	string or null	yes
content	string	yes

Status	Meaning	Body
200	OK	none

GET /api/projects/{projectId}/schemas/{schemaId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
schemaId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	none

PATCH /api/projects/{projectId}/schemas/{schemaId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
schemaId	path	string (uuid)	yes

Request body (application/json): UpdateSchemaRequest

Field	Type	Required	Notes
name	string or null	yes
description	string or null	yes
content	string or null	yes
setDescription	boolean	no	default false
setContent	boolean	no	default false

Status	Meaning	Body
200	OK	none

DELETE /api/projects/{projectId}/schemas/{schemaId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
schemaId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	none