Получение детальной информации о issues

Beta

Описание

Этот раздел документации описывает конечную точку для получения детальной информации о задачах (issues) в указанном репозитории. Если issues отсутствуют, API возвращает заглушку с пустым ответом.

Общие замечания

1. Для версий API указывайте заголовок Accept с соответствующей версией:

Accept: application/vnd.gitverse+json;version=1

2. Для работы с приватными ресурсами требуется авторизация через Bearer токен:

Authorization: Bearer \{user_token}

3. Базовый URL для всех конечных точек:

https://api.gitverse.ru

4. Если запрос завершается неудачно, API возвращает объект ошибки с кодом состояния HTTP и сообщением.

Описание метода

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

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

• {owner} — имя владельца репозитория (пользователя или организации);
• {repo} — название репозитория.

Заголовки запроса

• Content-Type: application/json: указывает, что тело ответа будет в формате JSON;
• Accept: application/vnd.gitverse+json;version=1: указывает версию API. В данном случае используется версия 1;
• Authorization: Bearer {user_token} (опционально): требуется для доступа к приватным репозиториям.

Тело запроса

Тело запроса не требуется. Этот метод работает без передачи данных в теле запроса.

Параметры ответа

Если issues отсутствуют, API возвращает заглушку с пустым ответом.

Пример структуры ответа

"Empty"

Где:

• Статус 200 OK: успешное выполнение операции. Ответ содержит заглушку "Empty", если issues отсутствуют.

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

GET https://api.gitverse.ru/repos/qweqwe1/russia_template/issues
Content-Type: application/json
Accept: application/vnd.gitverse+json;version=1
Authorization: Bearer YOUR_ACCESS_TOKEN

Пример ответа

"Empty"

Обработка ошибок

Если запрос завершается неудачно, API возвращает объект ошибки с кодом состояния HTTP и сообщением.

Пример ошибки

{
	"error": "Repository not found",
	"message": "The requested repository does not exist or you do not have access to it.",
	"status": 404
}

Возможные коды ошибок

• 400 Bad Request: неверный запрос (например, отсутствие обязательных параметров);
• 401 Unauthorized: необходима авторизация;
• 403 Forbidden: у пользователя нет прав на выполнение действия;
• 404 Not Found: репозиторий не найден;
• 500 Internal Server Error: внутренняя ошибка сервера.

Дополнительная информация

1. Если репозиторий является приватным, доступ к нему возможен только при наличии соответствующих прав.
2. Если в репозитории отсутствуют открытые задачи (issues), API возвращает заглушку "Empty".
3. Для использования конечной точки может потребоваться авторизация через Bearer токен, особенно если запрашиваемый репозиторий является приватным.

Если у вас возникнут вопросы или потребуется дополнительная информация, пожалуйста, обратитесь к документации API или свяжитесь с поддержкой.