Admiral
Changesets

Retrieve a revision's apply

GET
/v1/changesets/{change_set_id}/revisions/{revision}/apply

Scope: changeset:read

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer admp_...

In: header

Path Parameters

change_set_id*change_set_id

The change_set_id path parameter.

Match^cs-[0-9a-z]{12}$
revision*revision

The revision path parameter.

Formatint32
Range1 <= value

Response Body

application/json

curl -X GET "https://example.com/v1/changesets/string/revisions/1/apply"
{  "apply": {    "revision": 0,    "job_id": "string",    "status": "JOB_STATUS_UNSPECIFIED",    "wait_reason": "WAIT_REASON_UNSPECIFIED",    "plan_digest": "string",    "components": [      {        "component": "string",        "status": "JOB_STATUS_UNSPECIFIED",        "message": "string"      }    ],    "message": "string",    "applied_by": {      "id": "string",      "display_name": "string",      "email": "string"    },    "created_at": "2023-01-15T01:30:15.01Z",    "finished_at": "2023-01-15T01:30:15.01Z",    "accepted_by": {      "id": "string",      "display_name": "string",      "email": "string"    },    "accepted_reason": "string",    "accepted_at": "2023-01-15T01:30:15.01Z"  }}

Edit a change set POST

FAILED_PRECONDITION when `if_revision` or an upload's `from_revision` is not the head (the message names the head), when the change set is not a draft, and when a pin names a revoked revision (the message carries the recorded reason). ALREADY_EXISTS when a component name is live or held by another draft (the message names which). A contract violation is accepted: it is stored on the revision and returned. Scope: `changeset:write`

Retrieve a revision's rendered artifact GET

Scope: `changeset:read`