Skip to content

AssetFileResponseDto

Endpoints · All schemas

FieldRequiredDescription
createdAtYesCreation date
idYesAsset file ID
isEditedYesThe file was generated from an edit
isProgressiveYesThe file is a progressively encoded JPEG
isTransparentYesThe file is transparent
pathYesFile path
typeYesSee definition below
updatedAtYesUpdate date

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

{
  "properties": {
    "createdAt": {
      "description": "Creation date",
      "example": "2024-01-01T00:00:00.000Z",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "type": "string"
    },
    "id": {
      "description": "Asset file ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "isEdited": {
      "description": "The file was generated from an edit",
      "type": "boolean"
    },
    "isProgressive": {
      "description": "The file is a progressively encoded JPEG",
      "type": "boolean"
    },
    "isTransparent": {
      "description": "The file is transparent",
      "type": "boolean"
    },
    "path": {
      "description": "File path",
      "type": "string"
    },
    "type": {
      "$ref": "#/components/schemas/AssetFileType"
    },
    "updatedAt": {
      "description": "Update date",
      "example": "2024-01-01T00:00:00.000Z",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      "type": "string"
    }
  },
  "required": [
    "createdAt",
    "id",
    "isEdited",
    "isProgressive",
    "isTransparent",
    "path",
    "type",
    "updatedAt"
  ],
  "type": "object"
}