Получить метку репозитория

GET /repos/{owner}/{repo}/labels/{name}

Описание

Метод GET возвращает информацию об одной метке репозитория по ее идентификатору или названию (name). Параметр name принимает имя метки или ее целочисленный ID.

Метод применяется для проверки существования метки, получения ее текущих параметров (цвет, описание, признак исключительности) перед редактированием или назначением.

Заголовки

Параметр	Обязательный	Описание
`Accept`	Нет	Тип содержимого ответа. Рекомендуется установить значение `application/vnd.gitverse.object+json;version=1`
`Authorization`	Да	Токен доступа. Формат: `Bearer <YOUR-TOKEN>` или `token <YOUR-TOKEN>`

Параметры

Параметр	Где передать	Обязательный	Тип и формат	Описание
`owner`, `repo`	путь	Да	строка	Владелец и имя репозитория.
`name`	путь	Да	строка или целочисленный ID	Имя или ID метки. Не-ASCII имя нужно URL-кодировать.

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

Данный метод не поддерживает параметры запроса.

Тело запроса

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

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

curl -X GET "https://api.gitverse.ru/repos/user/my-repo/labels/bug" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/vnd.gitverse.object+json;version=1"

Замените YOUR_TOKEN на ваш личный токен доступа.

Пример ответа (`200 OK`)

При успешном выполнении сервер возвращает объект метки. Если метка не найдена, API возвращает 404 Not Found.

{
    "id": 126862,
    "name": "service_task",
    "exclusive": false,
    "is_archived": false,
    "color": "d1d9e0",
    "description": "",
    "url": "https://api.gitverse.ru/labels/126862"
}

Структура ответа

Ответ — объект 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.

Пример тела ошибки

При ответе 401 тело ответа имеет следующий вид:

{
  "error": {
    "code": "UNAUTHORIZED",
    "documentation_url": "https://gitverse.ru/docs/developers/public-api/",
    "message": "Authorization is required",
    "status": 401
  }
}

Проводник