Admiral
Changesets

Edit a change set

POST
/v1/changesets/{change_set_id}/edit

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

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}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/changesets/string/edit" \  -H "Content-Type: application/json" \  -d '{}'
{  "change_set": {    "id": "string",    "application_id": "string",    "environment_id": "string",    "title": "string",    "description": "string",    "status": "CHANGE_SET_STATUS_UNSPECIFIED",    "head_revision": 0,    "created_by": {      "id": "string",      "display_name": "string",      "email": "string"    },    "created_by_kind": "ACTOR_KIND_UNSPECIFIED",    "created_at": "2023-01-15T01:30:15.01Z",    "updated_at": "2023-01-15T01:30:15.01Z"  },  "revision": {    "number": 0,    "change_set_id": "string",    "base_generation": "string",    "cause": "REVISION_CAUSE_UNSPECIFIED",    "violations": [      {        "component": "string",        "path": "string",        "message": "string"      }    ],    "created_by": {      "id": "string",      "display_name": "string",      "email": "string"    },    "created_by_kind": "ACTOR_KIND_UNSPECIFIED",    "created_at": "2023-01-15T01:30:15.01Z",    "entries": [      {        "component_id": "string",        "component": "string",        "action": "ENTRY_ACTION_UNSPECIFIED",        "pin": {          "revision_id": "string",          "digest": "string",          "namespace": "string",          "name": "string"        },        "base_digest": "string",        "result_digest": "string",        "ops": [          {            "path": [              {                "key": "string"              }            ],            "op": "VALUE_OP_KIND_UNSPECIFIED",            "value_json": "string",            "from_present": true,            "from_value_json": "string"          }        ]      }    ]  },  "warnings": [    "string"  ]}