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}/threads

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
draftId	query	string (uuid)	no
targetId	query	string (uuid)	no
status	query	string	no

Status	Meaning	Body
200	OK	PageOfThreadDto

POST /api/projects/{projectId}/threads

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Request body (application/json): CreateThreadRequest

Field	Type	Required	Notes
target	TargetRequest	yes
body	string	yes
id	string (uuid) or null	no
draftId	string (uuid) or null	no
mentions	array of string or null	no

Status	Meaning	Body
200	OK	ThreadDto
201	Created	ThreadDto

GET /api/projects/{projectId}/threads/{threadId}

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

Status	Meaning	Body
200	OK	ThreadDto

POST /api/projects/{projectId}/threads/{threadId}/replies

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

Request body (application/json): ReplyRequest

Field	Type	Required	Notes
body	string	yes
id	string (uuid) or null	no
mentions	array of string or null	no

Status	Meaning	Body
200	OK	CommentDto
201	Created	CommentDto

PATCH /api/projects/{projectId}/threads/{threadId}/comments/{commentId}

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

Request body (application/json): EditCommentRequest

Field	Type	Required	Notes
body	string	yes
mentions	array of string or null	no

Status	Meaning	Body
200	OK	CommentDto

DELETE /api/projects/{projectId}/threads/{threadId}/comments/{commentId}

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

Status	Meaning	Body
204	No Content	none

POST /api/projects/{projectId}/threads/{threadId}/resolve

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

Status	Meaning	Body
200	OK	ThreadDto

POST /api/projects/{projectId}/threads/{threadId}/reopen

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

Status	Meaning	Body
200	OK	ThreadDto

POST /api/projects/{projectId}/threads/{threadId}/raise-question

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

Status	Meaning	Body
200	OK	QuestionDto
201	Created	QuestionDto

POST /api/projects/{projectId}/threads/{threadId}/raise-decision

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

Request body (application/json): RaiseDecisionRequest

Field	Type	Required	Notes
title	string	yes
decision	string	yes

Status	Meaning	Body
201	Created	DecisionDto