Messages 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}/messages

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

Status	Meaning	Body
200	OK	none

POST /api/projects/{projectId}/messages

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
branchId	query	string (uuid)	no

Request body (application/json): AddMessageRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
description	string or null	yes
producerId	string (uuid)	yes
consumerIds	array of string (uuid)	yes
schemaId	string (uuid) or null	yes
tags	array of string or null	yes

Status	Meaning	Body
200	OK	none

GET /api/projects/{projectId}/messages/{messageId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
messageId	path	string (uuid)	yes
branchId	query	string (uuid)	no

Status	Meaning	Body
200	OK	none

PATCH /api/projects/{projectId}/messages/{messageId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
messageId	path	string (uuid)	yes
branchId	query	string (uuid)	no

Request body (application/json): UpdateMessageRequest

Field	Type	Required	Notes
name	string or null	yes
description	string or null	yes
producerId	string (uuid) or null	yes
consumerIds	array of string (uuid) or null	yes
schemaId	string (uuid) or null	yes
setSchemaId	boolean	no	default false
setDescription	boolean	no	default false
setProducerId	boolean	no	default false
setConsumerIds	boolean	no	default false
tags	array of string or null	no
factStatus	string or null	no
provenance	null or ProvenanceInput	no
setProvenance	boolean	no	default false

Status	Meaning	Body
200	OK	none

DELETE /api/projects/{projectId}/messages/{messageId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
messageId	path	string (uuid)	yes
branchId	query	string (uuid)	no

Status	Meaning	Body
200	OK	none