schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "required": [
    "base_path",
    "content_id",
    "description",
    "details",
    "document_type",
    "links",
    "locale",
    "public_updated_at",
    "schema_name",
    "title",
    "updated_at"
  ],
  "additionalProperties": false,
  "properties": {
    "analytics_identifier": {
      "$ref": "#/definitions/analytics_identifier"
    },
    "base_path": {
      "$ref": "#/definitions/absolute_path"
    },
    "content_id": {
      "$ref": "#/definitions/guid"
    },
    "description": {
      "$ref": "#/definitions/description_optional"
    },
    "details": {
      "$ref": "#/definitions/details"
    },
    "document_type": {
      "type": "string",
      "enum": [
        "document_collection"
      ]
    },
    "first_published_at": {
      "anyOf": [
        {
          "$ref": "#/definitions/first_published_at"
        },
        {
          "type": "null"
        }
      ]
    },
    "links": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "available_translations": {
          "description": "Link type automatically added by Publishing API",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "child_taxons": {
          "description": "Link type automatically added by Publishing API",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "children": {
          "description": "Link type automatically added by Publishing API",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "document_collections": {
          "description": "Link type automatically added by Publishing API",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "documents": {
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "finder": {
          "description": "Powers links from content back to finders the content is surfaced on",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "government": {
          "description": "The government associated with this document",
          "$ref": "#/definitions/frontend_links_with_base_path",
          "maxItems": 1
        },
        "lead_organisations": {
          "description": "DEPRECATED: A subset of organisations that should be emphasised in relation to this content item. All organisations specified here should also be part of the organisations array.",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "level_one_taxons": {
          "description": "Link type automatically added by Publishing API",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "mainstream_browse_pages": {
          "description": "Powers the /browse section of the site. These are known as sections in some legacy apps.",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "meets_user_needs": {
          "description": "The user needs this piece of content meets.",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "ministers": {
          "description": "Link type automatically added by Publishing API",
          "$ref": "#/definitions/frontend_links"
        },
        "ordered_related_items": {
          "description": "Related items, can be any page on GOV.UK. Mostly used for mainstream content to power the sidebar. Ordering of the links is determined by the editor in Content Tagger.",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "ordered_related_items_overrides": {
          "description": "Related items, can be any page on GOV.UK. Overrides 'more like this' automatically generated links in the beta navigation.",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "organisations": {
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "original_primary_publishing_organisation": {
          "description": "The organisation that published the original version of the page. Corresponds to the first of the 'Lead organisations' in Whitehall for the first edition, and is empty for all other publishing applications.",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "parent": {
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "part_of_step_navs": {
          "description": "Link type automatically added by Publishing API",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "policies": {
          "description": "Link type automatically added by Publishing API",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "policy_areas": {
          "description": "A largely deprecated tag currently only used to power email alerts.",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "primary_publishing_organisation": {
          "description": "The organisation that published the page. Corresponds to the first of the 'Lead organisations' in Whitehall, and is empty for all other publishing applications.",
          "$ref": "#/definitions/frontend_links_with_base_path",
          "maxItems": 1
        },
        "related_guides": {
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "related_mainstream_content": {
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "related_policies": {
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "related_to_step_navs": {
          "description": "Link type automatically added by Publishing API",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "role_appointments": {
          "description": "Link type automatically added by Publishing API",
          "$ref": "#/definitions/frontend_links"
        },
        "secondary_to_step_navs": {
          "description": "Link type automatically added by Publishing API",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "suggested_ordered_related_items": {
          "description": "New A/B test suggestions for related items. Used for displaying related content on most pages, except for step-by-step and fatality notices. Links and their ordering are determined by the machine learning algorithms included in this A/B test.",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "taxons": {
          "description": "Prototype-stage taxonomy label for this content item",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "topic_taxonomy_taxons": {
          "description": "Link type automatically added by Publishing API",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "topical_events": {
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "topics": {
          "$ref": "#/definitions/frontend_links_with_base_path"
        }
      }
    },
    "locale": {
      "$ref": "#/definitions/locale"
    },
    "need_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "phase": {
      "description": "The service design phase of this content item - https://www.gov.uk/service-manual/phases",
      "type": "string",
      "enum": [
        "alpha",
        "beta",
        "live"
      ]
    },
    "public_updated_at": {
      "anyOf": [
        {
          "$ref": "#/definitions/public_updated_at"
        },
        {
          "type": "null"
        }
      ]
    },
    "publishing_app": {
      "$ref": "#/definitions/publishing_app_name"
    },
    "publishing_request_id": {
      "$ref": "#/definitions/publishing_request_id"
    },
    "publishing_scheduled_at": {
      "anyOf": [
        {
          "$ref": "#/definitions/publishing_scheduled_at"
        },
        {
          "type": "null"
        }
      ]
    },
    "rendering_app": {
      "$ref": "#/definitions/rendering_app"
    },
    "scheduled_publishing_delay_seconds": {
      "anyOf": [
        {
          "$ref": "#/definitions/scheduled_publishing_delay_seconds"
        },
        {
          "type": "null"
        }
      ]
    },
    "schema_name": {
      "type": "string",
      "enum": [
        "document_collection"
      ]
    },
    "title": {
      "$ref": "#/definitions/title"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "withdrawn_notice": {
      "$ref": "#/definitions/withdrawn_notice"
    }
  },
  "definitions": {
    "description": {
      "type": "string"
    },
    "absolute_path": {
      "description": "A path only. Query string and/or fragment are not allowed.",
      "type": "string",
      "pattern": "^/(([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})+(/([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)*)?$"
    },
    "analytics_identifier": {
      "description": "A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "body": {
      "description": "The main content provided as HTML rendered from govspeak",
      "type": "string"
    },
    "brexit_no_deal_notice": {
      "description": "A list of URLs and titles for a brexit no deal notice.",
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "title",
          "href"
        ],
        "additionalProperties": false,
        "properties": {
          "href": {
            "type": "string"
          },
          "title": {
            "type": "string"
          }
        }
      }
    },
    "change_history": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "public_timestamp",
          "note"
        ],
        "additionalProperties": false,
        "properties": {
          "note": {
            "description": "A summary of the change",
            "type": "string"
          },
          "public_timestamp": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    },
    "description_optional": {
      "anyOf": [
        {
          "$ref": "#/definitions/description"
        },
        {
          "type": "null"
        }
      ]
    },
    "details": {
      "type": "object",
      "required": [
        "collection_groups",
        "political"
      ],
      "additionalProperties": false,
      "properties": {
        "body": {
          "$ref": "#/definitions/body"
        },
        "brexit_no_deal_notice": {
          "$ref": "#/definitions/brexit_no_deal_notice"
        },
        "change_history": {
          "$ref": "#/definitions/change_history"
        },
        "collection_groups": {
          "description": "The ordered list of collection groups",
          "type": "array",
          "items": {
            "description": "Collection group",
            "type": "object",
            "required": [
              "title",
              "documents"
            ],
            "additionalProperties": false,
            "properties": {
              "body": {
                "$ref": "#/definitions/body"
              },
              "documents": {
                "description": "An ordered list of documents in this collection group",
                "type": "array",
                "items": {
                  "$ref": "#/definitions/guid"
                }
              },
              "title": {
                "type": "string"
              }
            }
          }
        },
        "emphasised_organisations": {
          "$ref": "#/definitions/emphasised_organisations"
        },
        "first_public_at": {
          "$ref": "#/definitions/first_public_at"
        },
        "government": {
          "$ref": "#/definitions/government"
        },
        "political": {
          "$ref": "#/definitions/political"
        },
        "tags": {
          "$ref": "#/definitions/tags"
        }
      }
    },
    "emphasised_organisations": {
      "description": "The content ids of the organisations that should be displayed first in the list of organisations related to the item, these content ids must be present in the item organisation links hash.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/guid"
      }
    },
    "first_public_at": {
      "description": "DEPRECATED. The date the content was first published. Used in details. Deprecated in favour of top level `first_published_at`.",
      "type": "string",
      "format": "date-time"
    },
    "first_published_at": {
      "description": "The date the content was first published.  Automatically determined by the publishing-api, unless overridden by the publishing application.",
      "type": "string",
      "format": "date-time"
    },
    "frontend_links": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "content_id",
          "locale",
          "title"
        ],
        "additionalProperties": true,
        "properties": {
          "analytics_identifier": {
            "$ref": "#/definitions/analytics_identifier"
          },
          "api_path": {
            "$ref": "#/definitions/absolute_path"
          },
          "api_url": {
            "description": "DEPRECATED: api_path should be used instead of api_url. This is due to values of api_url being tied to an environment which can cause problems when data is synced between environments. In time this field will be removed by the Publishing Platform team.",
            "type": "string",
            "format": "uri"
          },
          "base_path": {
            "$ref": "#/definitions/absolute_path"
          },
          "content_id": {
            "$ref": "#/definitions/guid"
          },
          "document_type": {
            "type": "string"
          },
          "links": {
            "type": "object",
            "patternProperties": {
              "^[a-z_]+$": {
                "$ref": "#/definitions/frontend_links"
              }
            }
          },
          "locale": {
            "$ref": "#/definitions/locale"
          },
          "public_updated_at": {
            "oneOf": [
              {
                "$ref": "#/definitions/public_updated_at"
              },
              {
                "type": "null"
              }
            ]
          },
          "schema_name": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "web_url": {
            "description": "DEPRECATED: base_path should be used instead of web_url. This is due to values of web_url being tied to an environment which can cause problems when data is synced between environments. In time this field will be removed by the Publishing Platform team.",
            "type": "string",
            "format": "uri"
          }
        }
      }
    },
    "frontend_links_with_base_path": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "base_path",
          "content_id",
          "locale",
          "title"
        ],
        "additionalProperties": true,
        "properties": {
          "analytics_identifier": {
            "$ref": "#/definitions/analytics_identifier"
          },
          "api_path": {
            "$ref": "#/definitions/absolute_path"
          },
          "api_url": {
            "description": "DEPRECATED: api_path should be used instead of api_url. This is due to values of api_url being tied to an environment which can cause problems when data is synced between environments. In time this field will be removed by the Publishing Platform team.",
            "type": "string",
            "format": "uri"
          },
          "base_path": {
            "$ref": "#/definitions/absolute_path"
          },
          "content_id": {
            "$ref": "#/definitions/guid"
          },
          "document_type": {
            "type": "string"
          },
          "links": {
            "type": "object",
            "patternProperties": {
              "^[a-z_]+$": {
                "$ref": "#/definitions/frontend_links_with_base_path"
              }
            }
          },
          "locale": {
            "$ref": "#/definitions/locale"
          },
          "public_updated_at": {
            "oneOf": [
              {
                "$ref": "#/definitions/public_updated_at"
              },
              {
                "type": "null"
              }
            ]
          },
          "schema_name": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "web_url": {
            "description": "DEPRECATED: base_path should be used instead of web_url. This is due to values of web_url being tied to an environment which can cause problems when data is synced between environments. In time this field will be removed by the Publishing Platform team.",
            "type": "string",
            "format": "uri"
          }
        }
      }
    },
    "government": {
      "description": "DEPRECATED: Content should be associated with a government through a link",
      "type": "object",
      "required": [
        "title",
        "slug",
        "current"
      ],
      "additionalProperties": false,
      "properties": {
        "current": {
          "description": "Is the government that published this document still the current government.",
          "type": "boolean"
        },
        "slug": {
          "description": "Government slug, used for analytics, eg '1970-to-1974-conservative-government'.",
          "type": "string"
        },
        "title": {
          "description": "Name of the government that first published this document, eg '1970 to 1974 Conservative government'.",
          "type": "string"
        }
      }
    },
    "guid": {
      "type": "string",
      "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"
    },
    "locale": {
      "type": "string",
      "enum": [
        "ar",
        "az",
        "be",
        "bg",
        "bn",
        "cs",
        "cy",
        "da",
        "de",
        "dr",
        "el",
        "en",
        "es",
        "es-419",
        "et",
        "fa",
        "fi",
        "fr",
        "gd",
        "gu",
        "he",
        "hi",
        "hr",
        "hu",
        "hy",
        "id",
        "is",
        "it",
        "ja",
        "ka",
        "kk",
        "ko",
        "lt",
        "lv",
        "ms",
        "mt",
        "ne",
        "nl",
        "no",
        "pa",
        "pa-pk",
        "pl",
        "ps",
        "pt",
        "ro",
        "ru",
        "si",
        "sk",
        "sl",
        "so",
        "sq",
        "sr",
        "sv",
        "sw",
        "ta",
        "th",
        "tk",
        "tr",
        "uk",
        "ur",
        "uz",
        "vi",
        "yi",
        "zh",
        "zh-hk",
        "zh-tw"
      ]
    },
    "political": {
      "description": "If the content is considered political in nature, reflecting views of the government it was published under.",
      "type": "boolean"
    },
    "public_updated_at": {
      "description": "When the content was last significantly changed (a major update). Shown to users.  Automatically determined by the publishing-api, unless overridden by the publishing application.",
      "type": "string",
      "format": "date-time"
    },
    "publishing_app_name": {
      "description": "The application that published this item.",
      "type": "string",
      "enum": [
        "account-api",
        "calculators",
        "calendars",
        "collections-publisher",
        "contacts",
        "content-publisher",
        "content-tagger",
        "email-alert-frontend",
        "external-link-tracker",
        "feedback",
        "frontend",
        "government-frontend",
        "hmrc-manuals-api",
        "info-frontend",
        "licencefinder",
        "local-links-manager",
        "manuals-publisher",
        "maslow",
        "performanceplatform-big-screen-view",
        "publisher",
        "rummager",
        "search-admin",
        "search-api",
        "service-manual-publisher",
        "share-sale-publisher",
        "short-url-manager",
        "smartanswers",
        "special-route-publisher",
        "specialist-publisher",
        "static",
        "tariff",
        "travel-advice-publisher",
        "whitehall"
      ]
    },
    "publishing_request_id": {
      "description": "A unique identifier used to track publishing requests to rendered content",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "publishing_scheduled_at": {
      "description": "When this content was last scheduled for publishing. Determined by the publishing intent sent by the publishing API.",
      "type": "string",
      "format": "date-time"
    },
    "rendering_app": {
      "description": "The application that renders this item.",
      "type": "string",
      "enum": [
        "account-api",
        "calculators",
        "calendars",
        "collections",
        "content-store",
        "email-alert-frontend",
        "email-campaign-frontend",
        "feedback",
        "finder-frontend",
        "frontend",
        "government-frontend",
        "info-frontend",
        "licencefinder",
        "performanceplatform-big-screen-view",
        "rummager",
        "search-api",
        "service-manual-frontend",
        "smartanswers",
        "spotlight",
        "static",
        "tariff",
        "whitehall-admin",
        "whitehall-frontend"
      ]
    },
    "scheduled_publishing_delay_seconds": {
      "description": "The delay between the most recent scheduled and actual publishing times. Determined by the content store based on the publishing intent.",
      "type": "integer"
    },
    "tags": {
      "description": "Field used by email-alert-api to trigger email alerts for subscriptions to topics (gov.uk/topic) and policies (gov.uk/policies).",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "additional_topics": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "browse_pages": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "policies": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "primary_topic": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "topics": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "title": {
      "type": "string"
    },
    "withdrawn_notice": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "explanation": {
          "type": "string"
        },
        "withdrawn_at": {
          "format": "date-time"
        }
      }
    }
  }
}