Checklist

Publish a new specification version

Changed on

Publishes a new version rather than editing in place. The response is a new specification ID under the same name and NRN, with the version number bumped. Approval actions keep pointing at the version they already reference until you move them.

patch/approval/checklist/specification/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/approval/checklist/specification/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the version to base the new one on.

Request body

namestring

New name for the specification family.

descriptionstring

New description.

definitionobject

The full definition for the new version.

Example request

{
  "name": "staging-deploy-gate",
  "description": "Coverage raised to 85% after the Q3 review."
}

Response

The new version was published.

idstring

Identifier of this specification version.

nrnstring

Where the specification applies. Child resources inherit it.

namestring

Shared by every version of this specification.

descriptionstring

What this checklist enforces.

status'active' | 'deleted'

Whether the specification is live or was soft-deleted.

versioninteger

Version number within the name and NRN.

derived_expressionstring

The boolean expression nullplatform computes the outcome with.

created_bystring

ID of the user who published this version.

created_atstring date-time

When this version was published.

updated_atstring date-time

When this version was last modified.

warningsstring[]

Non-blocking notes the validator raised when the version was saved.

versionsChecklistSpecification[] circular
associated_actionsobject[]

Approval actions currently pointing at this version. Only on a read of a single specification, and absent rather than empty when it was not resolved.

Example response

{
  "id": "spec_abc123def456ghij",
  "nrn": "organization=1:account=2:namespace=3",
  "name": "staging-deploy-gate",
  "description": "Coverage, Snyk, and security sign-off, with a CAB override.",
  "status": "active",
  "version": 1,
  "definition": {
    "execution_trigger": "automatic_approval"
  },
  "derived_expression": "( coverage_gate.passed AND security_signoff.passed ) OR cab_override.passed",
  "created_by": "4321",
  "created_at": "2026-08-28T14:12:03.000Z",
  "updated_at": "2026-08-28T14:12:03.000Z",
  "warnings": [],
  "associated_actions": [
    {
      "id": 1842,
      "nrn": "organization=1:account=2:namespace=3",
      "entity": "deployment",
      "action": "deployment:create"
    }
  ]
}

Changes

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status