Получить комментарии к задаче или запросу на слияние

GET /repos/{owner}/{repo}/issues/{issue_number}/comments

Описание

Метод GET возвращает список всех комментариев, оставленных в задаче или запросе на слияние с указанным индексом (issue_number). Поддерживается фильтрация по дате создания комментариев.

Этот метод полезен для отображения обсуждений, синхронизации с внешними системами и анализа активности.

Токен

Требуется токен с правами на Чтение для Репозитория.

Заголовки

Параметр	Обязательный	Описание
`accept`	Нет	Тип содержимого ответа. Рекомендуется установить значение `application/vnd.gitverse.object+json;version=latest`

Параметры пути

В URL запроса необходимо передать следующие идентификаторы ресурса:

Параметр	Тип	Обязательный	Описание
`owner`	string	Да	Владелец репозитория (пользователь или организация)
`repo`	string	Да	Название репозитория (без расширения `.git`)
`issue_number`	integer	Да	Индекс запроса на слияние в репозитории (целое число)

Параметры запроса

Для фильтрации результатов по времени можно использовать следующие параметры:

Параметр	Тип	Обязательный	Описание
`since`	string	Нет	Только комментарии, созданные после указанной даты (в формате RFC 3339, например: `2025-01-01T00:00:00Z`)
`before`	string	Нет	Только комментарии, созданные до указанной даты (в формате RFC 3339)

💡 Совет: оба параметра (since и before) можно использовать одновременно для ограничения временного диапазона.

Тело запроса

Данный метод не требует тела запроса.

Пример запроса

Ниже приведен пример использования curl для получения комментариев к запросу на слияние с индексом 42, созданных после 1 октября 2025 года.

curl -X GET "https://api.gitverse.ru/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"

Замените YOUR_TOKEN на ваш личный токен доступа. Заголовок Accept фиксирует использование первой версии API.

Ответ при успешном получении (200 OK)

Если запрос выполнен успешно, сервер вернет ответ с кодом 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/repos/gitverse-team/core-api/issues/42",
    "author_association": "MEMBER"
  }
]

Структура объекта комментария

Каждый элемент массива в ответе содержит следующие поля:

Поле	Тип	Описание
`id`	integer	Уникальный идентификатор комментария
`body`	string	Текст комментария
`user`	object	Информация об авторе комментария
`user.login`	string	Логин автора
`user.id`	integer	ID автора
`user.avatar_url`	string	Ссылка на аватар
`user.html_url`	string	Ссылка на профиль
`created_at`	string	Дата создания (формат RFC 3339)
`updated_at`	string	Дата последнего изменения (формат RFC 3339)
`html_url`	string	Прямая ссылка на комментарий в веб-интерфейсе
`issue_url`	string	Ссылка на запрос на слияние
`author_association`	string	Роль автора: `OWNER`, `MEMBER`, `CONTRIBUTOR`, `NONE`

Коды ответа

Результат выполнения запроса определяется по HTTP-статусу:

Код	Статус	Описание
`200`	OK	Список комментариев успешно получен
`400`	Bad Request	Некорректный формат параметров (например, неверная дата)
`401`	Unauthorized	Не передан или недействителен токен авторизации
`403`	Forbidden	Нет прав на чтение репозитория
`404`	Not Found	Репозиторий или запрос на слияние с указанным индексом не найдены
`429`	Too Many Requests	Превышен лимит запросов
`500`	Internal Server Error	Внутренняя ошибка сервера

Формат ответа и заголовки

Метод возвращает ответ в формате JSON. Заголовок Content-Type устанавливается в application/vnd.gitverse.object+json;version=1.

Проводник