ChangeRequest

A governed change to one domain: what it touches, how far it has got, and which domain version it settled at.

  • object
    Type: string

    Resource type identifier

  • slots
    Type: array of string

    The parts of the domain this change holds while it runs. Another change touching any of the same parts is refused with 409 until this one settles.

  • applied_version
    Type: integer

    The domain version this change settled at, which is the version GET /domains/{id} reports once it is visible. Null until the change lands; the highest when the change carried several mutations.

  • base_version
    Type: integer

    The domain version the change was composed against, or 0 when the requester asserted nothing about what they had read.

  • comment
    Type: string

    The requester's own note. Never interpreted.

  • failure_code
    Type: string

    Why the change could not be applied. Present only in state failed.

  • cancellation_reason
    Type: stringenum

    Why the change was retired. Present only in state cancelled. One of requested, expired, superseded, feasibility_lost, stale_base_version.

    values
    requestedexpiredsupersededfeasibility_loststale_base_version
  • cancellation_comment
    Type: string

    What whoever retired the change said about doing so, in their own words. Present only when a person cancelled it and chose to explain themselves; the reason beside it says which of the five endings this was.

  • requested_by
    Type: Actor

    Who asked for the change. Polymorphic by method.

    Properties: 6
  • cancelled_by
    Type: Actor

    Who retired the change, in the same shape. Absent while the change is still open, and absent on one that ran to completion.

    Properties: 6
  • expires_at
    Type: string

    When the change stops waiting for a decision. Null when nothing gated it.

  • id
    Type: string

    Change request typeid (prefix chr_)

  • settled_at
    Type: string

    When the change reached a terminal state. Null while it is still running. On a cancelled change this is when it was cancelled.

  • created_at
    Type: string

    When the change was submitted

  • updated_at
    Type: string

    When the change last moved

  • approval
    Type: ChangeApproval

    How far the change has got through the gates its organization's rules demanded. Absent when nothing gated it, which is every change with outcome: allow.

    Properties: 10
  • viewer
    Type: ChangeViewer

    What you may do with this change. Render the action bar from it rather than deriving one.

    Properties: 2
  • domain_id
    Type: string

    The domain this change acts on

  • domain_name
    Type: string

    The domain's name at the time of reading. Empty when the domain is no longer readable, which a change outliving its domain produces.

  • state
    Type: stringenum

    Fine-grained lifecycle state. One of draft, pending_approval, approved, executing, pending_registry, applied, failed, rejected, cancelled.

    values
    draftpending_approvalapprovedexecutingpending_registryappliedfailedrejectedcancelled
  • display_status
    Type: stringenum

    Coarse badge projected from state. One of draft, awaiting_review, applying, applied, auto_applied, overridden, rejected, expired, cancelled, failed. Branch on this to render; branch on state only when you need the detail.

    values
    draftawaiting_reviewapplyingappliedauto_appliedoverriddenrejectedexpiredcancelledfailed
  • outcome
    Type: "allow" or "review"enum

    What the policy check decided when the change was submitted. allow means nothing had to be reviewed.

  • evaluation_pass
    Type: integer

    Which judgement of this change the rest of the record belongs to, from 1. A change judged once and applied stays at 1. It climbs when the gate ran again before the change was applied and the world had moved: the signatures already given were given under an earlier pass, and GET /changes/{id}/issues says what the later one found.

  • kinds
    Type: array of string

    The classes of mutation this change carries, in the order they are applied. A change touching several fields carries several.