Skip to main content
PATCH
/
v1
/
projects
/
{project}
/
releases
/
{release}
cURL
curl --request PATCH \
  --url https://api.example.com/v1/projects/{project}/releases/{release} \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "files": [
    {
      "id": "<string>",
      "path": "<string>",
      "type": "TYPE_UNSPECIFIED",
      "version": "<string>",
      "enableGhost": true,
      "sheet": "<string>",
      "statement": "<string>"
    }
  ],
  "vcsSource": {
    "vcsType": "VCS_TYPE_UNSPECIFIED",
    "url": "<string>"
  },
  "digest": "<string>"
}
'
{
  "name": "<string>",
  "title": "<string>",
  "files": [
    {
      "id": "<string>",
      "path": "<string>",
      "type": "TYPE_UNSPECIFIED",
      "version": "<string>",
      "enableGhost": true,
      "sheet": "<string>",
      "statement": "<string>",
      "sheetSha256": "<string>",
      "statementSize": "<string>"
    }
  ],
  "vcsSource": {
    "vcsType": "VCS_TYPE_UNSPECIFIED",
    "url": "<string>"
  },
  "creator": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "state": "STATE_UNSPECIFIED",
  "digest": "<string>"
}

Path Parameters

​
project
string
required

The project id.

​
release
string
required

The release id.

Query Parameters

​
updateMask
string<field-mask>

The list of fields to be updated.

​
allowMissing
boolean

If set to true, and the release is not found, a new release will be created. In this situation, update_mask is ignored.

Body

application/json
​
title
string

The title of the release.

​
files
object[]

The SQL files included in the release.

​
vcsSource
object

The version control source of the release.

​
digest
string

The digest of the release. The user can provide the digest of the release. It can be used later to retrieve the release in GetRelease. Whether to provide digest and how to generate it is up to the user. If the digest is not empty, it must be unique in the project. Otherwise, an ALREADY_EXISTS error will be returned.

Response

OK

​
name
string

Format: projects/{project}/releases/{release}

​
title
string

The title of the release.

​
files
object[]

The SQL files included in the release.

​
vcsSource
object

The version control source of the release.

​
creator
string

Format: users/[email protected]

​
createTime
string<date-time>
​
state
enum<string>

The lifecycle state of the release.

Available options:
STATE_UNSPECIFIED,
ACTIVE,
DELETED
​
digest
string

The digest of the release. The user can provide the digest of the release. It can be used later to retrieve the release in GetRelease. Whether to provide digest and how to generate it is up to the user. If the digest is not empty, it must be unique in the project. Otherwise, an ALREADY_EXISTS error will be returned.