16. GET /repos/{owner}/{repo}/issues/{index}/comments
— получить комментарии к задаче или пул-реквесту
Описание
Возвращает список всех комментариев, оставленных к задаче (issue) или пул-реквесту (pull request) с указанным индексом.
Поддерживается фильтрация по дате создания комментариев.
Метод полезен для отображения обсуждений, синхронизации с внешними системами и анализа активности.
В настоящий момент метод позволяет получить комментарии только к запросам на слияние (pr). Работа с комментариями к задачам (issues) будет добавлена позже.
Параметры URL
Параметр | Обязательный | Описание |
---|---|---|
owner | Да | Владелец репозитория (пользователь или организация) |
repo | Да | Название репозитория (без расширения .git ) |
index | Да | Индекс задачи или пул-реквеста в репозитории (целое число) |
Параметры запроса
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
since | string | Нет | Только комментарии, созданные после указанной даты (в формате RFC3339, например: 2025-01-01T00:00:00Z ) |
before | string | Нет | Только комментарии, созданные до указанной даты (в формате RFC3339) |
⚠️ Оба параметра (
since
,before
) можно использовать одновременно для ограничения временного диапазона.
Тело запроса
Данный метод не требует тела запроса.
Пример запроса
curl -X GET "https://api.gitverse.ru/public/api/repos/gitverse-team/core-api/issues/42/comments?since=2025-10-01T00:00:00Z" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Accept: application/vnd.gitverse.object+json;version=1"
Ответ (200 OK)
Пример JSON-ответа:
[
{
"id": 98765,
"body": "Спасибо за замечание! Исправим в ближайшем релизе.",
"user": {
"login": "developer1",
"id": 789,
"avatar_url": "https://gitverse.ru/avatars/789.png",
"html_url": "https://gitverse.ru/developer1"
},
"created_at": "2025-10-01T14:30:00Z",
"updated_at": "2025-10-01T14:30:00Z",
"html_url": "https://gitverse.ru/gitverse-team/core-api/issues/42#issuecomment-98765",
"issue_url": "https://gitverse.ru/api/public/api/repos/gitverse-team/core-api/issues/42",
"author_association": "MEMBER"
}
]
Формат ответа
application/vnd.gitverse.object+json;version=1
Поля каждого комментария
Поле | Тип | Описание |
---|---|---|
id | integer | Уникальный идентификатор комментария |
body | string | Текст комментария |
user | object | Информация об авторе |
user.login | string | Логин автора |
user.id | integer | ID автора |
user.avatar_url | string | Ссылка на аватар |
user.html_url | string | Ссылка на профиль |
created_at | string | Дата создания (RFC3339) |
updated_at | string | Дата последнего изменения |
html_url | string | Прямая ссылка на комментарий в веб-интерфейсе |
issue_url | string | Ссылка на задачу или пул-реквест |
author_association | string | Роль автора: OWNER , MEMBER , CONTRIBUTOR , NONE |
Коды ответа
Код | Статус | Описание |
---|---|---|
200 | OK | Список комментариев успешно получен |
400 | Bad Request | Некорректный формат параметров (например, неверная дата) |
401 | Unauthorized | Не передан или недействителен токен авторизации |
403 | Forbidden | Нет прав на чтение репозитория |
404 | Not Found | Репозиторий или задача с указанным индексом не найдены |
500 | Internal Server Error | Внутренняя ошибка сервера |