Удаление комментария к задаче или запросу на слияние
DELETE /repos/{owner}/{repo}/issues/{issue_number}/comments/{comment_id}
Описание
Метод DELETE удаляет указанный комментарий к задаче или запросу на слияние в репозитории.
Ответ на запрос не содержит тела. Статус HTTP-ответа указывает на результат операции:
- код
204 No Contentозначает, что комментарий был успешно удален; - код
404 Not Foundозначает, что комментарий не найден или не существует.
Этот метод полезен для автоматизации процессов, например, для удаления устаревших комментариев бота или очистки обсуждения перед слиянием запроса.
Токен
Требуется токен с правами на Запись для Репозитория.
Заголовки
| Параметр | Обязательный | Описание |
|---|---|---|
Accept | Нет | Тип содержимого ответа. Рекомендуется установить значение application/vnd.gitverse.object+json;version=latest |
Authorization | Да | Токен доступа. Формат: Bearer <YOUR-TOKEN> или token <YOUR-TOKEN> |
Параметры пути
В URL запроса необходимо передать следующие идентификаторы ресурса:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
owner | string | Да | Владелец репозитория (пользователь или организация) |
repo | string | Да | Название репозитория |
issue_number | integer | Да | Номер задачи или запроса на слияние |
comment_id | integer | Да | Уникальный идентификатор комментария |
Параметры запроса и тело запроса
Данный метод не принимает параметров строки запроса и не требует тела запроса.
Пример запроса
Ниже приведен пример использования curl для удаления комментария с id=789 в запросе на слияние с номером 42 репозитория my-repo организации my-org.
curl -X DELETE "https://api.gitverse.ru/repos/my-org/my-repo/issues/42/comments/789" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Accept: application/vnd.gitverse.object+json;version=1"Замените YOUR_TOKEN на ваш личный токен доступа. Заголовок Accept фиксирует использование первой версии API.
Ответ при успешном удалении (204 No Content)
Если комментарий был успешно удален, сервер вернет ответ с кодом 204 No Content. Тело ответа будет пустым.
Коды ответа
Результат выполнения запроса определяется по HTTP-статусу:
| Код | Статус | Описание |
|---|---|---|
204 | No Content | Комментарий успешно удален. |
400 | Bad Request | Один из параметров передан некорректно. |
401 | Unauthorized | Не передан или невалиден токен авторизации. |
403 | Forbidden | Нет прав на удаление комментария (комментарий создан другим пользователем, либо недостаточно прав в репозитории). |
404 | Not Found | Репозиторий, запрос на слияние или комментарий не найдены. |
500 | Internal Server Error | Внутренняя ошибка сервера. |
Пример тела ошибки
При ответе 400 тело ответа имеет следующий вид:
{
"error": {
"code": "BAD_REQUEST",
"documentation_url": "https://gitverse.ru/docs/developers/public-api/",
"message": "The request format is invalid",
"status": 400
}
}Формат ответа и заголовки
Так как метод возвращает только статус без тела, формат содержимого (Content-Type) не применяется. Однако заголовок Accept в запросе должен быть установлен в application/vnd.gitverse.object+json;version=1.