Update a release

PATCH

/repos/{owner}/{repo}/releases/{id}

curl --request PATCH \
  --url https://gitea.com/api/v1/repos/example/example/releases/1 \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "body": "example", "draft": true, "name": "example", "prerelease": true, "tag_name": "example", "target_commitish": "example" }'

Authorizations

• BasicAuth
• Token
• AccessToken
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

id

required

integer format: int64

Id of the release to edit

Request Body

Media typeapplication/json

EditReleaseOption options when editing a release

object

body

The new release notes or description

string

draft

Whether to change the draft status

boolean

name

The new display title of the release

string

prerelease

Whether to change the prerelease status

boolean

tag_name

The new name of the git tag

string

target_commitish

The new target commitish for the release

string

Example^generated

{
  "body": "example",
  "draft": true,
  "name": "example",
  "prerelease": true,
  "tag_name": "example",
  "target_commitish": "example"
}

Responses

200

Release

Media typeapplication/json

Release represents a repository release

object

assets

The files attached to the release

Array<object>

Attachment a generic attachment

object

browser_download_url

DownloadURL is the URL to download the attachment

string

created_at

string format: date-time

download_count

DownloadCount is the number of times the attachment has been downloaded

integer format: int64

id

ID is the unique identifier for the attachment

integer format: int64

name

Name is the filename of the attachment

string

size

Size is the file size in bytes

integer format: int64

uuid

UUID is the unique identifier for the attachment file

string

author

User represents a user

object

active

Is user active

boolean

avatar_url

URL to the user’s avatar

string

created

string format: date-time

description

The user’s description

string

email

string format: email

followers_count

User counts

integer format: int64

following_count

integer format: int64

full_name

The user’s full name

string

html_url

URL to the user’s gitea page

string

id

The user’s id

integer format: int64

is_admin

Is the user an administrator

boolean

language

User locale

string

last_login

string format: date-time

location

The user’s location

string

login

Login of the user, same as username

string

login_name

Identifier of the user, provided by the external authenticator (if configured)

string

default: empty

prohibit_login

Is user login prohibited

boolean

restricted

Is user restricted

boolean

source_id

The ID of the user’s Authentication Source

integer format: int64

starred_repos_count

integer format: int64

visibility

User visibility level option: public, limited, private

string

website

The user’s website

string

body

The release notes or description

string

created_at

string format: date-time

draft

Whether the release is a draft

boolean

html_url

The HTML URL to view the release

string

id

The unique identifier of the release

integer format: int64

name

The display title of the release

string

prerelease

Whether the release is a prerelease

boolean

published_at

string format: date-time

tag_name

The name of the git tag associated with the release

string

tarball_url

The URL to download the tarball archive

string

target_commitish

The target commitish for the release

string

upload_url

The URL template for uploading release assets

string

url

The API URL of the release

string

zipball_url

The URL to download the zip archive

string

Example

{
  "author": {
    "login_name": "empty"
  }
}

404

APINotFound is a not found empty response

Media typeapplication/json