Folder

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Folder",
  "title": "Folder",
  "type": "object",
  "x-apideck-schema-id": "Folder",
  "x-apideck-weights": {
    "id": "critical",
    "downstream_id": "edge-case",
    "name": "critical",
    "size": "low",
    "downloadable": "low",
    "parent_folders": "high",
    "parent_folders_complete": "critical",
    "updated_at": "critical",
    "created_at": "high"
  },
  "additionalProperties": false,
  "required": [
    "name",
    "parent_folders"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "downstream_id": {
      "$ref": "#/components/schemas/DownstreamId"
    },
    "name": {
      "type": "string",
      "description": "The name of the folder",
      "example": "Documents"
    },
    "description": {
      "type": "string",
      "description": "Optional description of the folder",
      "example": "My Personal Documents",
      "nullable": true
    },
    "path": {
      "type": "string",
      "description": "The full path of the folder (includes the folder name)",
      "example": "/Personal/Documents",
      "readOnly": true,
      "nullable": true
    },
    "size": {
      "type": "integer",
      "description": "The size of the folder in bytes",
      "example": 1810673,
      "readOnly": true,
      "nullable": true
    },
    "downloadable": {
      "type": "boolean",
      "description": "Whether the current user can download the contents of this folder",
      "nullable": true
    },
    "owner": {
      "$ref": "#/components/schemas/Owner"
    },
    "parent_folders": {
      "type": "array",
      "description": "The parent folders of the file, starting from the root",
      "items": {
        "$ref": "#/components/schemas/LinkedFolder"
      }
    },
    "parent_folders_complete": {
      "type": "boolean",
      "description": "Whether the list of parent folder is complete. Some connectors only return the direct parent of a folder",
      "readOnly": true
    },
    "custom_mappings": {
      "$ref": "#/components/schemas/CustomMappings"
    },
    "updated_by": {
      "$ref": "#/components/schemas/UpdatedBy"
    },
    "created_by": {
      "$ref": "#/components/schemas/CreatedBy"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    }
  }
}