Release

Update release

Update the name, description, or tags of an existing release.

put/api/projects/{projectId}/releases/{releaseId}

Request

The document declares no server URL.
Auth
- HTTP bearer
- or HTTP internal
TypeScript
https://skmtc.dev/gorules/apis/gorules-agent-api/docs/api/projects/:projectId/releases/:releaseId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdstring uuid required

Project unique identifier

releaseIdstring uuid required

Release unique identifier

Request body

namestring nullable

Updated release name

descriptionstring nullable

Updated release description

tagsstring[] nullable

Release tags

Response

Updated release information

idstring uuid required

Release unique identifier

createdAtstring required

Release creation timestamp

deletedAtstring nullable

Release deletion timestamp

namestring nullable

Release name

descriptionstring nullable

Release description

versionnumber nullable

Legacy numeric version

semanticVersionstring nullable

Semantic version (e.g., 1.0.0)

status'draft' | 'published' | 'completed'

Release status

projectIdstring uuid required

Project ID the release belongs to

createdByIdstring uuid nullable

ID of the user who created the release

commitIdstring uuid nullable

Associated commit ID

Changes

No recorded changes to this operation across all 1 revision of this API.