Получить список меток репозитория
GET /repos/{owner}/{repo}/labels
Описание
Метод GET возвращает список меток, определенных в указанном репозитории. Метки используются для классификации задач и запросов на слияние.
Поддерживается пагинация через параметры page и limit, а также сортировка через параметр sort (порядок сортировки, поддерживаемый сервером).
Метод применяется для отображения списка доступных меток в интерфейсе, для проверки существования меток перед назначением и для интеграции с внешними системами.
Важно: учитывается приватность репозитория. Если репозиторий приватный, а запрос выполняется не владельцем, соавтором или участником команды с доступом к репозиторию, возвращается ошибка 404.
Заголовки
| Параметр | Обязательный | Описание |
|---|---|---|
Accept | Нет | Тип содержимого ответа. Рекомендуется установить значение application/vnd.gitverse.object+json;version=1 |
Authorization | Да | Токен доступа. Формат: Bearer <YOUR-TOKEN> или token <YOUR-TOKEN> |
Параметры
| Параметр | Где передать | Тип | Обязательный | Описание |
|---|---|---|---|---|
owner, repo | путь | string | Да | Владелец и имя репозитория. |
page | query | integer | Нет | Номер страницы для пагинации (начиная с 1). По умолчанию: 1. |
limit | query | integer | Нет | Количество меток на странице. По умолчанию: 30. |
sort | query | string | Нет | Способ сортировки результатов. |
Тело запроса
Данный метод не требует тела запроса. Все параметры передаются через URL и query-строку.
Пример запроса
curl -X GET "https://api.gitverse.ru/repos/user/my-repo/labels?limit=50&page=1" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Accept: application/vnd.gitverse.object+json;version=1"
Замените YOUR_TOKEN на ваш личный токен доступа.
Пример ответа (200 OK)
При успешном выполнении сервер возвращает массив объектов меток. Общее количество доступно в заголовке X-Total-Count.
[
{
"id": 1759,
"name": "Priority/Blocker",
"exclusive": true,
"is_archived": false,
"color": "efbee3",
"description": "Блокирующий",
"url": "https://api.gitverse.ru/labels/1759"
},
{
"id": 1758,
"name": "test_label",
"exclusive": true,
"is_archived": false,
"color": "fbcab2",
"description": "Тестовая метка",
"url": "https://api.gitverse.ru/labels/1758"
}
]
Структура ответа
Ответ — массив объектов Label (метки). Полная структура описана в графе объектов, раздел «Объект Label».
На корневом уровне каждый элемент содержит:
| Поле | Тип | Описание |
|---|---|---|
id | integer | Идентификатор метки |
name | string | Название |
description | string | Описание |
color | string | Цвет (hex без #) |
exclusive | boolean | Признак исключительности |
is_archived | boolean | Заархивирована ли |
url | string | API-ссылка |
Коды ответа
| Код | Статус | Описание |
|---|---|---|
200 | OK | Список меток успешно получен. |
401 | Unauthorized | Не передан или невалиден токен авторизации. |
403 | Forbidden | Нет прав на доступ к репозиторию. |
404 | Not Found | Репозиторий не найден или нет доступа. |
500 | Internal Server Error | Внутренняя ошибка сервера GitVerse. |
Примечания
- общее количество меток доступно в заголовке
X-Total-Count.