API ReferenceContext Repository
List releases
Returns the project's release history, newest first.
GET /context/v1/releases
Returns the project's release history, newest first. A release is one published state of the whole context repository; each published change creates the next. Pass release to read one release by number, or tag to read the release currently holding that tag; the two cannot be combined, and a tag no release holds is a 404. The response also reports which release is the latest.
Requires the context:read scope.
Parameters
| Parameter | Location | Required | Description |
|---|---|---|---|
limit | query | no | Return at most this many releases, from 1 to 200. Defaults to 50. |
offset | query | no | Skip this many releases before returning. Defaults to 0. |
tag | query | no | Return the release currently holding this tag. A tag no release holds is a 404. Cannot be combined with release. |
release | query | no | Return this one release, by number or canonical name (projects/{project}/releases/{n}). Cannot be combined with tag. |
Responses
| Status | Meaning |
|---|---|
200 | The request succeeded. |
401 | The token is missing, expired or invalid. |
403 | The token does not carry the scope this operation requires. |
404 | No such project, or the token belongs to a different project. |
422 | The request was not valid: a parameter or the body failed validation. |
The 200 response body:
| Field | Type | Required | Description |
|---|---|---|---|
latest | integer or null | no | The number of the latest release, or null before the first one. |
releases | array of ReleaseRecord | yes | The releases asked for. |
Shapes
The named shapes used above.
ReleaseRecord
One published state of the whole repository.
| Field | Type | Required | Description |
|---|---|---|---|
changeset_id | string | yes | The changeset whose publication made this release. |
changeset_revision | integer or null | no | The revision the changeset was at when it was published. |
created_at | string | yes | When the release was made. |
created_by | object | yes | Who published it and why. |
deleted | array of string | yes | The ids of the objects this release retired. |
name | string or null | no | The release's canonical name, projects/{project}/releases/{release}. A request that takes a release in a query accepts this name in its place; a URL path takes the bare number. It is null when the id cannot be written in a canonical name. |
object_versions | map of integer | yes | The version of every object as this release published it. |
project_id | string | yes | The project the release belongs to. |
release | integer | yes | The release number. Each published change makes the next. |
tag_history | array of object | yes | Every time a tag was added to or removed from this release, oldest first. |
tags | array of string | yes | The tags this release carries. |
Example
curl -sS "$API_URL/context/v1/releases" \
-H "Authorization: Bearer $TOKEN"