Config Revision

string

required

status

enum<string>

required

Available options:

draft,

pending-review,

approved,

changes-requested,

merged,

discarded

authorId

string

required

Who acted: a member's user ID, or an API key's ID when it acted as itself

reviews

object[]

required

Show child attributes

activityLog

object[]

required

Show child attributes

dateCreated

string<date-time>

required

dateUpdated

string<date-time>

required

baseConfig

object

required

Show child attributes

proposedConfig

object

required

Show child attributes

proposedChanges

object[]

required

Show child attributes

version

integer

title

string

author

object

Who created the revision, with an API key's name

Show child attributes

authorEmail

string

contributors

string[]

revertedFrom

string

autoPublishOnApproval

boolean

Publish automatically the moment this revision is approved.

autoPublishEnabledBy

string

User or API key the deferred publish runs as, re-checked when it fires. A key that assumed a member's role is recorded as <keyId>:<memberId>.

autoPublishEnabledByUser

object

Who armed the deferred publish, with an API key's name

Show child attributes

scheduledPublishAt

string<date-time>

When the deferred publish fires. Absent when the revision publishes on approval instead, or is not armed at all.

scheduledPublishLockEdits

boolean

Content edits to this revision are frozen until it fires.

scheduledPublishLockOthers

boolean

Other revisions of the same resource cannot publish until this one fires or is cancelled.

scheduledPublishBypassApproval

boolean

Armed by a caller who bypassed the approval requirement. Such a schedule must be cancelled and re-armed rather than edited.

scheduledPublishAttempts

integer

How many times the poller has tried to publish this revision.

scheduledPublishLastError

string

Why the most recent deferred-publish attempt failed.

scheduledPublishGaveUpAt

string<date-time>

When the poller stopped retrying. Giving up CLEARS the schedule and disarms auto-publish, so nothing fires again until the revision is re-armed. The draft is left open, with scheduledPublishLastError preserved for context.

resolution

object

Show child attributes

{
  "id": "<string>",
  "authorId": "<string>",
  "reviews": [
    {
      "id": "<string>",
      "userId": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z",
      "comment": "<string>",
      "stale": true
    }
  ],
  "activityLog": [
    {
      "id": "<string>",
      "userId": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "proposedChangesSnapshot": [
        {
          "op": "add",
          "path": "<string>",
          "value": "<unknown>"
        }
      ],
      "targetSnapshot": "<unknown>"
    }
  ],
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateUpdated": "2023-11-07T05:31:56Z",
  "baseConfig": {
    "id": "<string>",
    "key": "<string>",
    "name": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "owner": "<string>",
    "ownerEmail": "<string>",
    "parent": "<string>",
    "extends": [
      "<string>"
    ],
    "value": {},
    "scopedOverrides": [
      {
        "config": "<string>",
        "environments": [
          "<string>"
        ],
        "projects": [
          "<string>"
        ]
      }
    ],
    "description": "<string>",
    "project": "<string>",
    "archived": true,
    "extensible": true,
    "invariants": [
      {
        "name": "<string>",
        "rule": {},
        "message": "<string>"
      }
    ],
    "locked": true,
    "experimentGuard": true,
    "lockedBy": "<string>",
    "dateLocked": "2023-11-07T05:31:56Z"
  },
  "proposedConfig": {
    "id": "<string>",
    "key": "<string>",
    "name": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "owner": "<string>",
    "ownerEmail": "<string>",
    "parent": "<string>",
    "extends": [
      "<string>"
    ],
    "value": {},
    "scopedOverrides": [
      {
        "config": "<string>",
        "environments": [
          "<string>"
        ],
        "projects": [
          "<string>"
        ]
      }
    ],
    "description": "<string>",
    "project": "<string>",
    "archived": true,
    "extensible": true,
    "invariants": [
      {
        "name": "<string>",
        "rule": {},
        "message": "<string>"
      }
    ],
    "locked": true,
    "experimentGuard": true,
    "lockedBy": "<string>",
    "dateLocked": "2023-11-07T05:31:56Z"
  },
  "proposedChanges": [
    {
      "op": "add",
      "path": "<string>",
      "value": "<unknown>"
    }
  ],
  "version": 123,
  "title": "<string>",
  "authorEmail": "<string>",
  "contributors": [
    "<string>"
  ],
  "revertedFrom": "<string>",
  "autoPublishOnApproval": true,
  "autoPublishEnabledBy": "<string>",
  "scheduledPublishAt": "2023-11-07T05:31:56Z",
  "scheduledPublishLockEdits": true,
  "scheduledPublishLockOthers": true,
  "scheduledPublishBypassApproval": true,
  "scheduledPublishAttempts": 123,
  "scheduledPublishLastError": "<string>",
  "scheduledPublishGaveUpAt": "2023-11-07T05:31:56Z"
}

Introduction

Endpoints

Models