Вехи
Этот раздел API описывает методы работы с вехами репозитория: управление вехами (создание, получение, редактирование, закрытие и повторное открытие, удаление) и привязка задач к вехам.
Веха — именованная группа задач со сроком выполнения, используется для планирования релизов. Веха имеет два состояния: open (открыта) и closed (закрыта).
Доступ к методам следует ролевой модели репозитория: читать вехи могут пользователи с доступом на чтение к репозиторию, создавать, изменять и удалять — пользователи с правами на запись.
Вехи
1. GET /repos/{owner}/{repo}/milestones
Возвращает список вех репозитория. Поддерживает пагинацию, фильтрацию по состоянию, поиск по названию/описанию и сортировку.
2. POST /repos/{owner}/{repo}/milestones
Создает новую веху.
3. GET /repos/{owner}/{repo}/milestones/{id}
Возвращает веху по ее идентификатору.
4. PATCH /repos/{owner}/{repo}/milestones/{id}
Обновляет веху: название, описание, состояние (open/closed) и срок выполнения. В том числе закрытие и повторное открытие вехи.
5. DELETE /repos/{owner}/{repo}/milestones/{id}
Удаляет веху. Задачи не удаляются — только отвязываются от вехи.
Задачи и вехи
6. POST /repos/{owner}/{repo}/issues
Создает задачу и при необходимости сразу добавляет ее в веху (поле milestone_id).
7. POST /repos/{owner}/{repo}/issues/{issue_number}
Добавляет существующую задачу в веху или убирает ее из вехи (поле milestone_id).
См. также
Веха также присутствует в ответах следующих методов:
- Получить задачу или запрос на слияние — детали задачи, включая веху;
- Получить задачи и запросы в репозитории — список задач с фильтрацией;
- Получить таймлайн задачи или запроса на слияние — история и комментарии задачи.
Возможные ошибки
| Код | Описание |
|---|---|
400 Bad Request | Некорректный формат данных |
401 Unauthorized | Необходима авторизация |
403 Forbidden | Недостаточно прав |
404 Not Found | Репозиторий, веха или задача не найдены |
422 Unprocessable Entity | Ошибка валидации данных (при привязке задачи к вехе — некорректный milestone_id) |
500 Internal Server Error | Внутренняя ошибка сервера |