{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/good-grants/json-schema/good-grants-document-schema.json",
  "title": "Document",
  "description": "Document generated from a document template and attached to an application, allocation, or user.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/good-grants-documents-api-openapi.yml#/components/schemas/Document",
  "type": "object",
  "properties": {
    "allocation": {
      "description": "Allocation the document is attached to, or an empty array when not attached to one.",
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "description": "Short URL-safe identifier for the allocation."
            },
            "link": {
              "type": "string",
              "format": "uri",
              "description": "Canonical URL for the allocation resource."
            }
          }
        },
        {
          "type": "array",
          "maxItems": 0
        }
      ]
    },
    "application": {
      "description": "Application the document is attached to, or an empty array when not attached to one.",
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "description": "Short URL-safe identifier for the application."
            },
            "link": {
              "type": "string",
              "format": "uri",
              "description": "Canonical URL for the application resource."
            },
            "title": {
              "type": "string",
              "description": "Title of the application."
            }
          }
        },
        {
          "type": "array",
          "maxItems": 0
        }
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time when the document was created."
    },
    "description": {
      "type": "object",
      "description": "Description of the document, inherited from the document template, keyed by locale code.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "file": {
      "type": "object",
      "description": "Generated document file.",
      "properties": {
        "token": {
          "type": "string",
          "description": "Token identifying the file."
        },
        "link": {
          "type": "string",
          "format": "uri",
          "description": "Canonical URL for the file resource."
        },
        "name": {
          "type": "string",
          "description": "Original filename of the generated document."
        },
        "download": {
          "type": "string",
          "format": "uri",
          "description": "Time-limited download URL for the file."
        }
      }
    },
    "file_type": {
      "type": "string",
      "enum": [
        "PDF",
        "Word"
      ],
      "description": "File format of the generated document."
    },
    "name": {
      "type": "object",
      "description": "Name of the document, keyed by locale code.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "shared_with_user": {
      "type": "boolean",
      "description": "Specifies whether the document is shared with the applicant."
    },
    "slug": {
      "type": "string",
      "description": "URL-safe identifier of the document."
    },
    "user": {
      "description": "User who created the document, or an empty array when none is attached.",
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "description": "Short URL-safe identifier for the user."
            },
            "link": {
              "type": "string",
              "format": "uri",
              "description": "Canonical URL for the user resource."
            },
            "name": {
              "type": "string",
              "description": "Full name of the user."
            },
            "first_name": {
              "type": "string",
              "description": "First name of the user."
            },
            "last_name": {
              "type": "string",
              "description": "Last name of the user."
            }
          }
        },
        {
          "type": "array",
          "maxItems": 0
        }
      ]
    }
  }
}