Skip to content

StudioProjectSaveResponseDto

Endpoints · All schemas

FieldRequiredDescription
digestYesDigest of the head envelope
leaseYesSee definition below
replayedYesThis request key was already accepted; the earlier result is returned
resourcesNohow the sources of a newly written revision resolved; absent when nothing was written, null when the resolution could not run
revisionYesThe head after this request
revisionIdYesThe revision row; null when nothing was written
unchangedYesThe document equals the head, so no revision was written

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: StudioProjectLeaseDto, StudioProjectResourcesDto

{
  "properties": {
    "digest": {
      "description": "Digest of the head envelope",
      "type": "string"
    },
    "lease": {
      "$ref": "#/components/schemas/StudioProjectLeaseDto"
    },
    "replayed": {
      "description": "This request key was already accepted; the earlier result is returned",
      "type": "boolean"
    },
    "resources": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StudioProjectResourcesDto"
        }
      ],
      "description": "how the sources of a newly written revision resolved; absent when nothing was written, null when the resolution could not run",
      "nullable": true
    },
    "revision": {
      "description": "The head after this request",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "revisionId": {
      "description": "The revision row; null when nothing was written",
      "format": "uuid",
      "nullable": true,
      "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"
    },
    "unchanged": {
      "description": "The document equals the head, so no revision was written",
      "type": "boolean"
    }
  },
  "required": [
    "digest",
    "lease",
    "replayed",
    "revision",
    "revisionId",
    "unchanged"
  ],
  "type": "object"
}