# Release

Schemas

Software releases with their tag, title, release notes, author, pre-release flag, date, downloadable files with sizes and download counts, and source archives.

## Endpoints

1 endpoint returns releases on GitHub.

- [GETGitHub Releases API`/v1/github/releases`](https://socialtap.dev/docs/reference/github/releases/index.md)

## Schema

Every endpoint above returns an array of these objects as `data`, with a [`page`](https://socialtap.dev/docs/pagination/index.md) object. The standard [`meta`](https://socialtap.dev/docs/reference/index.md#meta) comes with every response.

| Field | Type | Description |
| --- | --- | --- |
| `platform` | `string` | Platform ID (github, …). |
| `id` | `string` | Platform-native release ID (string): the platform's own where it has one, else derived from its repository or package and its tag, stable for the release's life. |
| `url` | `string` (uri) | Canonical release page URL. |
| `tag` | `string` | The tag the release is cut from, as written (v19.3.1, react-dom@19.0.0); on a package registry, the version (2.32.3). |
| `title` | `string` or `null` | The release's title as its author wrote it; null when it has none (the platform's page then shows the tag). |
| `notes` | `string` or `null` | Release notes as the author wrote them, in Markdown (the platform's own flavor: links, headings, @mentions); null when the release has none. |
| `author` | `object` or `null` | The account that published the release (often a bot on automated releases); null when the platform does not name one. |
| `author.id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `author.username` | `string` or `null` | Handle without the @; null when the account has none. |
| `author.display_name` | `string` or `null` | Display name shown on the profile. |
| `author.url` | `string` (uri) or `null` | Canonical profile URL. |
| `author.avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `author.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `is_prerelease` | `boolean` or `null` | Marked by its author as a pre-release (beta, release candidate), not ready for production; null when the platform has no such mark. |
| `published_at` | `string` (date-time) or `null` | When the release was published, RFC 3339 UTC; on GitLab it can be a future date (an upcoming release). Null when the platform does not show it. |
| `assets` | `object[]` | Files published with the release, in the platform's order; \[\] when none (listed in unknown_fields when the source cannot see them). |
| `assets[].name` | `string` | The file's name, or on platforms whose assets are links (GitLab) the link's label. |
| `assets[].url` | `string` (uri) | Where the file downloads from (a permanent link; it may redirect to a CDN). |
| `assets[].size_bytes` | `integer` or `null` | File size in bytes; null when the platform does not state it (GitLab's links). |
| `assets[].sha256` | `string` or `null` | SHA-256 digest of the file, 64 lowercase hex characters; null when the platform does not publish one. |
| `assets[].metrics` | `object` | Counts at fetch time; null = not exposed, 0 = zero. |
| `assets[].metrics.download_count` | `integer` or `null` | Times the file was downloaded; null when the platform does not count them. |
| `tarball_url` | `string` (uri) or `null` | The source code at the release's tag as a .tar.gz archive, built by the platform; null when it serves none (a package registry, a repository that hides archives). |
| `zipball_url` | `string` (uri) or `null` | The source code at the release's tag as a .zip archive, built by the platform; null when it serves none. |
| `metrics` | `object` | Counts at fetch time; null = hidden or not exposed, 0 = zero. |
| `metrics.download_count` | `integer` or `null` | Downloads of the release's files: the sum of its assets' download counts. Source archives are not counted. Null when no asset's downloads are counted (a release with no files, a platform that counts none). |
| `platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\<platform>); each null when unknown. |
| `platform_specific.github` | `object` or `null` | A GitHub release's own fields. |
| `platform_specific.github.node_id` | `string` or `null` | GitHub's GraphQL node ID of the release (RE_kwDO…). |
| `platform_specific.github.target_commitish` | `string` or `null` | The branch or commit the release's tag was created from (main, or a commit SHA), as its author chose it. |
| `platform_specific.github.created_at` | `string` (date-time) or `null` | The date of the commit the release was created from, RFC 3339 UTC; published_at is when the release itself came out. |
| `platform_specific.github.updated_at` | `string` (date-time) or `null` | When the release was last edited (its notes or files), RFC 3339 UTC. |
| `platform_specific.github.is_immutable` | `boolean` or `null` | True when the release is immutable: its tag and files can no longer be changed or replaced. |
| `platform_specific.github.discussion_url` | `string` (uri) or `null` | The discussion thread opened for the release; null when it has none. |
| `platform_specific.github.mention_count` | `integer` or `null` | Accounts the release notes mention (GitHub's list of contributors under the release), 0 when they mention nobody; null when the source does not show them. |
| `platform_specific.github.reaction_count` | `integer` or `null` | Reactions to the release, all emoji together, 0 when nobody reacted; null when the source does not show them. |
| `platform_specific.github.reactions` | `object` | Reactions to the release by emoji, 0 for an emoji nobody used; each null when the source does not show them. |
| `platform_specific.github.reactions.thumbs_up_count` | `integer` or `null` | 👍 (+1) reactions; metrics.like_count. |
| `platform_specific.github.reactions.thumbs_down_count` | `integer` or `null` | 👎 (-1) reactions. |
| `platform_specific.github.reactions.laugh_count` | `integer` or `null` | 😄 reactions. |
| `platform_specific.github.reactions.hooray_count` | `integer` or `null` | 🎉 reactions. |
| `platform_specific.github.reactions.confused_count` | `integer` or `null` | 😕 reactions. |
| `platform_specific.github.reactions.heart_count` | `integer` or `null` | ❤️ reactions. |
| `platform_specific.github.reactions.rocket_count` | `integer` or `null` | 🚀 reactions. |
| `platform_specific.github.reactions.eyes_count` | `integer` or `null` | 👀 reactions. |
| `approximate_fields` | `string[]` | JSON paths of values rounded by the platform or parsed from display text. \[\] when all exact. |
| `unknown_fields` | `string[]` | JSON paths of lists whose \[\] means unknown rather than none (a source that cannot see a release's assets); null already means unknown for every other field. \[\] when every list is known. |

## Item errors

Besides the [request-level errors](https://socialtap.dev/docs/errors/index.md) every endpoint can return, release endpoints return:

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `not_found` | 404 | No | The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why). | Check the link or ID. Do not retry. |
| `private_or_unavailable` | 403 | No | The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code. | Only public items can be fetched. Do not retry. |

---

[HTML version](https://socialtap.dev/resources/release/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)
