Skip to content
GitmoapAPIBeta
Schema

Release

A release: notes attached to one git tag, with downloadable files and source archives.

Shape

  • authorActorSummaryWho created the release.
  • commit_shaCommitHash (string)The commit the tag pointed to when the release was created.
  • created_atstring
  • nameReleaseName (string)
  • repository_idRepositoryId (string · uuid)
  • tag_nameTagName (string)
  • updated_atstring
  • assetsarray of ReleaseAssetoptionalThe release's files. Included when a single release is fetched.
    • The ReleaseAsset schema
    • asset_idReleaseAssetId (string · uuid)
    • content_typestring
    • created_atstring
    • nameAssetName (string)
    • repository_idRepositoryId (string · uuid)
    • sizeinteger · int640–∞
    • stateAssetStateuploadingavailableWhether a release file has been uploaded: uploading (an upload URL was issued, but the upload has not been confirmed yet) or available.
    • tag_nameTagName (string)
    • updated_atstring
    • uploaderActorSummaryWho uploaded the file.
    • download_urlstring or nulloptionalWhere to download the file.
  • bodyReleaseBody (string) or nulloptional
  • draftbooleanoptionalWhether the release is an unpublished draft, visible only to people with Developer access or above.
  • prereleasebooleanoptionalWhether the release is marked as a pre-release. A pre-release is never returned as the latest release.
  • published_atstring or nulloptionalSet when the release leaves draft.
  • tarball_urlstring or nulloptionalWhere to download the tagged source as a .tar.gz archive.
  • versioninteger · int64optional0–∞Increases with every change. Send it with an update so that a change made since you read the release is not overwritten.
  • zipball_urlstring or nulloptionalWhere to download the tagged source as a .zip archive.

Example

Synthesized example
{
"author": {
"email": "lin@acme.example",
"id": "id-9de2",
"username": "tomas",
"avatar_url": "https://gitmoap.example/acme/bcf3b041"
},
"commit_sha": "f7351a13e8b32172d0eab6163e6eee4f324ea7b9",
"created_at": "2026-10-16T12:11:22Z",
"name": "payments-api",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"tag_name": "payments-api",
"updated_at": "2026-10-13T22:25:30Z",
"assets": [
{
"asset_id": "1b0b4bad-9b4f-4bd3-b182-d7cd8a39eaec",
"content_type": "content-type-6d9c",
"created_at": "2026-10-09T22:08:04Z",
"name": "payments-api",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"size": 7,
"state": "uploading",
"tag_name": "payments-api",
"updated_at": "2026-10-10T18:35:01Z",
"uploader": {
"email": "tomas@acme.example",
"id": "id-1d87",
"username": "mara"
}
}
],
"body": "Renders each region as density contours of its operations.",
"draft": false,
"prerelease": false,
"published_at": "2026-10-12T18:58:37Z",
"tarball_url": "https://gitmoap.example/acme/55d6bd5a",
"version": 54,
"zipball_url": "https://gitmoap.example/acme/7c6bd38a"
}

Graph

Used inside
Contains

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 5 operations