Skip to content

StudioBundleUploadDto

Endpoints · All schemas

FieldRequiredDescription
consumedAtYesWhen an import first read it
digestYesSHA-256 of the whole file
engineRevisionYesstring
expiresAtYesWhen the upload is discarded
exportedAtYesstring
fileNameYesThe file name as uploaded
idYesUpload ID, used to start an import
producerVersionYesstring
projectNameYesstring
revisionYesThe revision the bundle was made from
sizeBytesYesstring
sourcesYesarray

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: StudioBundleSourceDto

{
  "properties": {
    "consumedAt": {
      "description": "When an import first read it",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "digest": {
      "description": "SHA-256 of the whole file",
      "type": "string"
    },
    "engineRevision": {
      "type": "string"
    },
    "expiresAt": {
      "description": "When the upload is discarded",
      "format": "date-time",
      "type": "string"
    },
    "exportedAt": {
      "format": "date-time",
      "type": "string"
    },
    "fileName": {
      "description": "The file name as uploaded",
      "type": "string"
    },
    "id": {
      "description": "Upload ID, used to start an import",
      "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"
    },
    "producerVersion": {
      "type": "string"
    },
    "projectName": {
      "type": "string"
    },
    "revision": {
      "description": "The revision the bundle was made from",
      "maximum": 9007199254740991,
      "minimum": 1,
      "type": "integer"
    },
    "sizeBytes": {
      "type": "string"
    },
    "sources": {
      "items": {
        "$ref": "#/components/schemas/StudioBundleSourceDto"
      },
      "type": "array"
    }
  },
  "required": [
    "consumedAt",
    "digest",
    "engineRevision",
    "expiresAt",
    "exportedAt",
    "fileName",
    "id",
    "producerVersion",
    "projectName",
    "revision",
    "sizeBytes",
    "sources"
  ],
  "type": "object"
}