FileOperation

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "FileOperation",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the object.",
      "readOnly": true,
      "format": "uuid"
    },
    "type": {
      "type": "string",
      "example": "export",
      "description": "The type of file operation.",
      "readOnly": true,
      "enum": [
        "import",
        "export"
      ]
    },
    "format": {
      "type": "string",
      "description": "The file format of the resulting file.",
      "example": "outline-markdown",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "The name of the file operation, derived from the collection name, document title, or file name.",
      "readOnly": true
    },
    "state": {
      "type": "string",
      "description": "The state of the file operation.",
      "example": "complete",
      "readOnly": true,
      "enum": [
        "creating",
        "uploading",
        "complete",
        "error",
        "expired"
      ]
    },
    "error": {
      "type": "string",
      "nullable": true,
      "description": "An error message if the file operation failed.",
      "readOnly": true
    },
    "size": {
      "type": "string",
      "description": "The size of the resulting file in bytes. Returned as a string as the value may exceed the safe integer range.",
      "readOnly": true,
      "example": "2048"
    },
    "collectionId": {
      "type": "string",
      "nullable": true,
      "description": "Identifier for the associated collection, if the file operation is scoped to a single collection.",
      "readOnly": true,
      "format": "uuid"
    },
    "documentId": {
      "type": "string",
      "nullable": true,
      "description": "Identifier for the associated document, if the file operation is scoped to a single document.",
      "readOnly": true,
      "format": "uuid"
    },
    "user": {
      "$ref": "#/components/schemas/User"
    },
    "createdAt": {
      "type": "string",
      "description": "The date and time that this object was created",
      "readOnly": true,
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "description": "The date and time that this object was last changed",
      "readOnly": true,
      "format": "date-time"
    }
  }
}