Comments 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}/drafts/{draftId}/comments

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
draftId	path	string (uuid)	yes
entityId	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}/drafts/{draftId}/comments

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

Request body (application/json): CreateCommentRequest

Field	Type	Required	Notes
id	string (uuid)	yes
body	string	yes
entityId	string (uuid) or null	no
entityType	string or null	no

Status	Meaning	Body
200	OK	none

PATCH /api/projects/{projectId}/drafts/{draftId}/comments/{commentId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
draftId	path	string (uuid)	yes
commentId	path	string (uuid)	yes

Request body (application/json): UpdateCommentRequest

Field	Type	Required	Notes
body	string	yes

Status	Meaning	Body
200	OK	none

DELETE /api/projects/{projectId}/drafts/{draftId}/comments/{commentId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
draftId	path	string (uuid)	yes
commentId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	none