API: comments
GET /api/v1/comments
Заголовок раздела «GET /api/v1/comments»List Comments
: list filtered by target.
Авторизация: нужен Authorization: Bearer <token>
| Параметр | Где | Обязателен | Тип | Описание |
|---|---|---|---|---|
target_kind | query | нет | string | null | |
target_guid | query | нет | integer | null | |
include_deleted | query | нет | boolean | |
limit | query | нет | integer | |
offset | query | нет | integer |
Ответы:
| Код | Смысл | Тело |
|---|---|---|
200 | Successful Response | CommentList |
401 | Missing or invalid authentication credentials | ErrorResponse |
422 | Validation Error | HTTPValidationError |
POST /api/v1/comments
Заголовок раздела «POST /api/v1/comments»Create Comment
: create a comment, resolve @mentions, record agent mentions as an agent action.
Авторизация: нужен Authorization: Bearer <token>
| Параметр | Где | Обязателен | Тип | Описание |
|---|---|---|---|---|
Idempotency-Key | header | нет | string | Optional. |
Тело запроса: application/json — схема CommentCreate
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
body_markdown | string | да | |
target_guid | integer | да | |
target_kind | string | да |
Ответы:
| Код | Смысл | Тело |
|---|---|---|
201 | Successful Response | CommentRead |
401 | Missing or invalid authentication credentials | ErrorResponse |
422 | Validation Error | HTTPValidationError |
DELETE /api/v1/comments/{guid}
Заголовок раздела «DELETE /api/v1/comments/{guid}»Delete Comment
: soft-delete.
Авторизация: нужен Authorization: Bearer <token>
| Параметр | Где | Обязателен | Тип | Описание |
|---|---|---|---|---|
guid | path | да | integer | |
Idempotency-Key | header | нет | string | Optional. |
Ответы:
| Код | Смысл | Тело |
|---|---|---|
200 | Successful Response | object |
401 | Missing or invalid authentication credentials | ErrorResponse |
422 | Validation Error | HTTPValidationError |
GET /api/v1/comments/{guid}
Заголовок раздела «GET /api/v1/comments/{guid}»Get Comment
Авторизация: нужен Authorization: Bearer <token>
| Параметр | Где | Обязателен | Тип | Описание |
|---|---|---|---|---|
guid | path | да | integer |
Ответы:
| Код | Смысл | Тело |
|---|---|---|
200 | Successful Response | CommentRead |
401 | Missing or invalid authentication credentials | ErrorResponse |
422 | Validation Error | HTTPValidationError |
PATCH /api/v1/comments/{guid}
Заголовок раздела «PATCH /api/v1/comments/{guid}»Patch Comment
: PATCH only by author (or superuser).
Авторизация: нужен Authorization: Bearer <token>
| Параметр | Где | Обязателен | Тип | Описание |
|---|---|---|---|---|
guid | path | да | integer | |
Idempotency-Key | header | нет | string | Optional. |
Тело запроса: application/json — схема CommentUpdate
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
body_markdown | string | null | нет |
Пример:
{ "body_markdown": "Edited: the figure is confirmed by the source."}Ответы:
| Код | Смысл | Тело |
|---|---|---|
200 | Successful Response | CommentRead |
401 | Missing or invalid authentication credentials | ErrorResponse |
422 | Validation Error | HTTPValidationError |