PATCH /api/v1/comments/{guid}

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Patch Comment

: PATCH only by author (or superuser).

Auth: Authorization: Bearer <token> required

Request

curl -sS -X PATCH "https://entherium.duckdns.org:8443/api/v1/comments/<guid>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"body_markdown":"Edited: the figure is confirmed by the source."}'

Response `200`

The contract carries no example for this response; schema: CommentRead. Field-level shape: interactive explorer.

Returns

CommentRead — Successful Response

Field	Type	Description
`author_id`	`integer`
`body_markdown`	`string`
`createtime`	`string`
`deleted`	`boolean`
`guid`	`integer`
`mentions`	`array of object`
`target_guid`	`integer`
`target_kind`	`string`
`updatetime`	`string`

Parameters

Parameter	In	Required	Type	Default	Constraints	Description
`guid`	path	yes	`integer`	—	—
`Idempotency-Key`	header	no	`string`	—	uuid	Optional.

Request body

Field	Type	Required	Description
`body_markdown`	`string \| null`	no

Example:

{
  "body_markdown": "Edited: the figure is confirmed by the source."
}

Errors

Code	Meaning	Body
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.