Редактирование комментария к задаче или запросу на сляние
PATCH /repos/{owner}/{repo}/issues/{pull_id}/comments/{comment_id}
Описание
Метод PATCH обновляет текст существующего комментария к указанным задаче или запросу на слияние в репозитории.
⚠️ Важно: изменения применяются только к полю
body. Все остальные атрибуты комментария (автор, дата создания, привязка к коду) остаются без изменений. Ответ на запрос содержит обновленный объект комментария в формате JSON.
Этот метод полезен для автоматизации процессов редактирования комментариев: например, для обновления статуса проверки в комментариях автоматизированных сервисов (CI/CD) или корректировки текста после получения дополнительной информации.
Заголовки
| Параметр | Обязательный | Описание |
|---|---|---|
accept | Нет | Тип содержимого ответа. Рекомендуется установить значение application/vnd.gitverse.object+json;version=latest |
Параметры пути
В URL запроса необходимо передать следующие идентификаторы ресурса:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
owner | string | Да | Владелец репозитория (пользователь или организация) |
repo | string | Да | Название репозитория |
pull_id | integer | Да | Номер запроса на слияние |
comment_id | integer | Да | Уникальный идентификатор комментария |
Параметры и тело запроса
Данный метод не принимает параметров строки запроса.
Запрос должен содержать тело в формате JSON со следующим полем:
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
body | string | Да | Новый текст комментария. Полностью заменяет предыдущее содержимое. Поддерживается разметка Markdown. Максимальная длина — 65536 символов. |
Пример запроса
Ниже приведен пример использования curl для обновления текста комментария с id=789 в запросе на слияние с номером 42.
curl -X PATCH "https://api.gitverse.ru/repos/my-org/my-repo/issues/42/comments/789" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-H "Accept: application/vnd.gitverse.object+json;version=1" \
-d '{
"body": "Обновленный текст комментария с учетом замечаний.\n\n✅ Проверено."
}'Замените YOUR_TOKEN на ваш личный токен доступа. Заголовок Content-Type обязателен, так как передается JSON-тело.
Ответ при успешном обновлении (200 OK)
Если комментарий был успешно обновлен, сервер вернет ответ с кодом 200 OK и телом в формате JSON, содержащим обновленный объект комментария. Ответ включает все поля комментария с измененным значением body (и обновленным значением updated_at).
Коды ответа
Результат выполнения запроса определяется по HTTP-статусу:
| Код | Статус | Описание |
|---|---|---|
200 | OK | Комментарий успешно обновлен. Тело ответа содержит объект комментария. |
400 | Bad Request | Один из параметров передан некорректно или поле body отсутствует/пустое. |
401 | Unauthorized | Не передан или невалиден токен авторизации. |
403 | Forbidden | Нет прав на редактирование комментария (комментарий создан другим пользователем либо недостаточно прав в репозитории). |
404 | Not Found | Репозиторий, запрос на слияние или комментарий не найдены. |
422 | Unprocessable Entity | Превышена максимальная длина комментария (65536 символов) или некорректный формат данных. |
500 | Internal Server Error | Внутренняя ошибка сервера. |
Формат ответа и заголовки
Метод возвращает ответ в формате JSON. Заголовок Content-Type в ответе устанавливается в application/vnd.gitverse.object+json;version=1. Тело ответа содержит объект комментария с обновленными полями.