5. PATCH /repos/{owner}/{repo}/releases/{release_id} — редактировать информацию о релизе
Beta
Описание
Этот метод позволяет отредактировать информацию о релизе по его идентификатору.
Параметры URL:
| Параметр | Обязательный | Описание |
|---|---|---|
owner | Да | Владелец репозитория (логин или имя организации) |
repo | Да | Название репозитория без расширения .git |
release_id | Да | Идентификатор релиза |
Параметры запроса:
Данный метод не требует параметров запроса.
Тело запроса:
Тело запроса содержит параметры для обновления релиза.
| Поле | Обязательный | Описание |
|---|---|---|
tag_name | Нет | Название тега |
name | Нет | Название релиза |
target_commitish | Нет | Название ветки или коммита, на который указывает тег |
body | Нет | Описание релиза |
draft | Нет | Флаг черновика (по умолчанию false) |
prerelease | Нет | Флаг предварительного релиза (по умолчанию false) |
Пример запроса:
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
}'Ответ (200 OK):
Возвращает обновленную информацию о релизе.
{
"id": 123,
"tag_name": "v1.0.1",
"name": "Release v1.0.1",
"body": "Обновленное описание релиза",
"draft": false,
"prerelease": 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 | Релиз не найден |
500 | Internal Server Error | Внутренняя ошибка сервера |
Примечания:
- убедитесь, что ключ API указан корректно и обладает необходимыми правами для доступа к репозиторию;
- можно обновлять только некоторые поля релиза.