Skip to content

StudioPreviewResponseDto

Endpoints · All schemas

FieldRequiredDescription
currentRevisionYesThe stored revision the project is on now
previewYesSee definition below
supersededPreviewIdsYesPreviews cancelled because the revision advanced

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.

Field definitions: StudioPreviewDto

{
  "properties": {
    "currentRevision": {
      "description": "The stored revision the project is on now",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "preview": {
      "$ref": "#/components/schemas/StudioPreviewDto"
    },
    "supersededPreviewIds": {
      "description": "Previews cancelled because the revision advanced",
      "items": {
        "format": "uuid",
        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "currentRevision",
    "preview",
    "supersededPreviewIds"
  ],
  "type": "object"
}