Channel

namestringrequired

published, or 1 to 32 lowercase letters, digits and dashes starting with a letter.

Example: staging

versionintegernullablerequired

The version the channel renders; null for published before anything was published.

canary objectnullablerequired

versionintegerrequired

percentintegerrequired

Possible values: >= 1 and <= 50

previous_versionintegernullablerequired

The version before the last move; rollback returns to it.

updated_atstring<date-time>required

usage_24h object[]

Renders of the last 24 hours that came through this channel, per version (list only).

Array [

versionintegerrequired

rendersintegerrequired

failedintegerrequired

]

schema_check object

Writes only: the schema comparison the move ran.

sourcestringrequired

Possible values: [stored, inferred, none]

breaking object[]required

Array [

pathstringrequired

Dotted field path; items[] for array elements, empty for the data itself.

Example: customer.email

pointerstringrequired

Example: /properties/customer/properties/email

kindstringrequired

Possible values: [field-added-required, field-added-optional, field-removed, field-became-required, field-became-optional, type-narrowed, type-widened, enum-values-removed, enum-values-added, enum-added, enum-removed, const-changed, constraint-tightened, constraint-relaxed, additional-properties-closed, additional-properties-opened, keyword-changed]

breakingbooleanrequired

messagestringrequired

Example: "customer.email" is now required

]

safe object[]required

Array [

pathstringrequired

Dotted field path; items[] for array elements, empty for the data itself.

Example: customer.email

pointerstringrequired

Example: /properties/customer/properties/email

kindstringrequired

Possible values: [field-added-required, field-added-optional, field-removed, field-became-required, field-became-optional, type-narrowed, type-widened, enum-values-removed, enum-values-added, enum-added, enum-removed, const-changed, constraint-tightened, constraint-relaxed, additional-properties-closed, additional-properties-opened, keyword-changed]

breakingbooleanrequired

messagestringrequired

Example: "customer.email" is now required

]

Channel

{
  "name": "staging",
  "version": 0,
  "canary": {
    "version": 0,
    "percent": 0
  },
  "previous_version": 0,
  "updated_at": "2024-07-29T15:51:28.071Z",
  "usage_24h": [
    {
      "version": 0,
      "renders": 0,
      "failed": 0
    }
  ],
  "schema_check": {
    "source": "stored",
    "breaking": [
      {
        "path": "customer.email",
        "pointer": "/properties/customer/properties/email",
        "kind": "field-added-required",
        "breaking": true,
        "message": "\"customer.email\" is now required"
      }
    ],
    "safe": [
      {
        "path": "customer.email",
        "pointer": "/properties/customer/properties/email",
        "kind": "field-added-required",
        "breaking": true,
        "message": "\"customer.email\" is now required"
      }
    ]
  }
}