Общие методы
Этот раздел API описывает общие методы работы с задачами и запросами на слияние. Методы работают через эндпоинт /issues/ (а также /labels) и применимы к обоим типам объектов, позволяя получать информацию о задачах и запросах, управлять комментариями, реакциями, метками, таймлайном и вложениями в комментарии.
Задачи и запросы
1. GET /repos/{owner}/{repo}/issues
Возвращает список задач и запросов на слияние в указанном репозитории.
2. GET /repos/{owner}/{repo}/issues/{issue_number}
Возвращает подробную информацию о задаче или запросе на слияние по его номеру.
3. PATCH /repos/{owner}/{repo}/issues/{issue_number}
Обновляет параметры существующей задачи или запроса на слияние.
Комментарии
4. GET /repos/{owner}/{repo}/issues/{issue_number}/comments
Возвращает список всех комментариев к задаче или запросу на слияние.
5. GET /repos/{owner}/{repo}/issues/comments/{id}
Возвращает детали отдельного комментария по его уникальному идентификатору.
6. POST /repos/{owner}/{repo}/issues/{issue_number}/comments
Создает новый комментарий в задаче или запросе на слияние.
7. PATCH /repos/{owner}/{repo}/issues/{issue_number}/comments/{comment_id}
Редактирует комментарий в задаче или запросе на слияние.
8. DELETE /repos/{owner}/{repo}/issues/{issue_number}/comments/{comment_id}
Удаляет комментарий в задаче или запросе на слияние.
Реакции на комментарии
9. POST /repos/{owner}/{repo}/issues/{issue_number}/comments/{comment_id}/reactions
Добавляет реакцию на комментарий к задаче или запросу на слияние.
10. DELETE /repos/{owner}/{repo}/issues/{issue_number}/comments/{comment_id}/reactions/{reaction_id}
Удаляет реакцию на комментарий в задаче или запросе на слияние.
Таймлайн
11. GET /repos/{owner}/{repo}/issues/{issue_number}/timeline
Возвращает таймлайн событий задачи или запроса на слияние (комментарии и события изменения).
Вложения в комментарии
12. POST /repos/{owner}/{repo}/issues/comments/{comment_id}/attachments
Загружает файл и прикрепляет его к комментарию в задаче или запросе на слияние.
13. DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/attachments/{attachment_id}
Удаляет файл из комментария в задаче или запросе на слияние.
Метки
14. GET /repos/{owner}/{repo}/labels
Возвращает список меток, определенных в указанном репозитории.
15. GET /repos/{owner}/{repo}/labels/{name}
Возвращает информацию об одной метке репозитория по имени.
16. POST /repos/{owner}/{repo}/labels
Создает новую метку в указанном репозитории.
17. PATCH /repos/{owner}/{repo}/labels/{name}
Редактирует существующую метку в репозитории: название, цвет, описание и признак исключительности.
Возможные ошибки
| Код | Описание |
|---|---|
400 Bad Request | Некорректный формат данных |
401 Unauthorized | Необходима авторизация |
403 Forbidden | Недостаточно прав |
404 Not Found | Задача, комментарий, реакция или метка не найдены |
422 Unprocessable Entity | Ошибка валидации данных |
429 Too Many Requests | Превышен лимит запросов |
500 Internal Server Error | Внутренняя ошибка сервера |