Редактировать информацию о релизе

PATCH /repos/{owner}/{repo}/releases/{release_id}

Описание

Этот метод позволяет отредактировать информацию о релизе по его идентификатору.

Токен

Требуется токен с правами на Запись для Репозитория.

Заголовки

Параметр	Обязательный	Описание
accept	Нет	Тип содержимого ответа. Рекомендуется установить значение application/vnd.gitverse.object+json;version=latest

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

Параметр	Обязательный	Описание
owner	Да	Владелец репозитория (логин или имя организации)
repo	Да	Название репозитория без расширения .git
release_id	Да	Идентификатор релиза

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

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

Тело запроса

Тело запроса содержит параметры для обновления релиза.

Поле	Обязательный	Описание
tag_name	Нет	Название тега
name	Нет	Название релиза
target_commitish	Нет	Название ветки или коммита, на который указывает тег
body	Нет	Описание релиза
draft	Нет	Флаг черновика (по умолчанию false)
prerelease	Нет	Флаг предварительного релиза (по умолчанию false)
is_authorized_only	Нет	Разрешение на скачивание прикрепленных файлов только для авторизованного пользователя

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

curl -X PATCH "https://api.gitverse.ru/repos/myuser/myrepo/releases/123" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/vnd.gitverse.object+json;version=1" \
  -H "Content-Type: application/json" \
  -d '{
    "tag_name": "v1.0.1",
    "name": "Release v1.0.1",
    "body": "Обновленное описание релиза",
    "draft": false,
    "prerelease": false,
    "is_authorized_only": false
  }'

Ответ (200 OK)

Возвращает обновленную информацию о релизе.

{
  "id": 123,
  "tag_name": "v1.0.1",
  "name": "Release v1.0.1",
  "body": "Обновленное описание релиза",
  "html_url": "https://gitverse.ru/myuser/myrepo/releases/tag/v1.0.1",
  "draft": false,
  "prerelease": false,
  "is_authorized_only": false,
  "created_at": "2023-01-01T00:00:00Z",
  "published_at": "2023-01-01T00:00:00Z",
  "author": {
    "login": "user1",
    "name": "User One"
  },
  "assets": []
}

Формат ответа: application/vnd.gitverse.object+json;version=1

Коды ответов

Код	Статус	Описание
200	Ok	Релиз успешно обновлен
400	Bad Request	Некорректные параметры запроса
401	Unauthorized	Необходима авторизация
403	Forbidden	Доступ запрещен
404	Not Found	Релиз не найден
429	Too Many Requests	Превышен лимит запросов
500	Internal Server Error	Внутренняя ошибка сервера

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

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

{
  "error": {
    "code": "BAD_REQUEST",
    "documentation_url": "https://gitverse.ru/docs/developers/public-api/",
    "message": "The request format is invalid",
    "status": 400
  }
}

Примечания

• убедитесь, что ключ API указан корректно и обладает необходимыми правами для доступа к репозиторию;
• можно обновлять только некоторые поля релиза.