StudioCommandEnvelopeDto

Endpoints · All schemas

Field	Required	Description
id	Yes	Published command id (studio/frameleaf-studio-commands.json)
idempotencyKey	Yes	string
issuedAt	Yes	Epoch milliseconds
payload	Yes	Command payload; graph-shaped values pass through unread
revision	Yes	The head revision the command was issued against

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "properties": {
    "id": {
      "description": "Published command id (studio/frameleaf-studio-commands.json)",
      "maxLength": 100,
      "minLength": 1,
      "type": "string"
    },
    "idempotencyKey": {
      "maxLength": 128,
      "minLength": 1,
      "type": "string"
    },
    "issuedAt": {
      "description": "Epoch milliseconds",
      "format": "double",
      "type": "number"
    },
    "payload": {
      "additionalProperties": {},
      "description": "Command payload; graph-shaped values pass through unread",
      "type": "object"
    },
    "revision": {
      "description": "The head revision the command was issued against",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "id",
    "idempotencyKey",
    "issuedAt",
    "payload",
    "revision"
  ],
  "type": "object"
}