schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "required": [
    "analytics_identifier",
    "base_path",
    "content_id",
    "description",
    "details",
    "document_type",
    "email_document_supertype",
    "expanded_links",
    "first_published_at",
    "government_document_supertype",
    "govuk_request_id",
    "links",
    "locale",
    "payload_version",
    "phase",
    "public_updated_at",
    "publishing_app",
    "redirects",
    "rendering_app",
    "routes",
    "schema_name",
    "title",
    "update_type"
  ],
  "additionalProperties": false,
  "properties": {
    "analytics_identifier": {
      "$ref": "#/definitions/analytics_identifier"
    },
    "base_path": {
      "$ref": "#/definitions/absolute_path"
    },
    "content_id": {
      "$ref": "#/definitions/guid"
    },
    "content_purpose_document_supertype": {
      "description": "DEPRECATED. Use `content_purpose_subgroup`.",
      "type": "string"
    },
    "content_purpose_subgroup": {
      "description": "Document subgroup grouping documents by purpose. Narrows down the purpose defined in content_purpose_supergroup.",
      "type": "string"
    },
    "content_purpose_supergroup": {
      "description": "Document supergroup grouping documents by a purpose",
      "type": "string"
    },
    "description": {
      "$ref": "#/definitions/description_optional"
    },
    "details": {
      "$ref": "#/definitions/details"
    },
    "document_type": {
      "type": "string",
      "enum": [
        "case_study"
      ]
    },
    "email_document_supertype": {
      "description": "Document supertype grouping intended to power the Whitehall finders and email subscriptions",
      "type": "string"
    },
    "expanded_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"
        },
        "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": {
          "description": "All organisations linked to this content item. This should include lead 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": {
          "description": "The parent content item.",
          "$ref": "#/definitions/frontend_links_with_base_path",
          "maxItems": 1
        },
        "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_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"
        },
        "topics": {
          "description": "Powers the /topic section of the site. These are known as specialist sectors in some legacy apps.",
          "$ref": "#/definitions/frontend_links_with_base_path"
        },
        "world_locations": {
          "$ref": "#/definitions/frontend_links"
        },
        "worldwide_organisations": {
          "$ref": "#/definitions/frontend_links_with_base_path"
        }
      }
    },
    "first_published_at": {
      "$ref": "#/definitions/first_published_at"
    },
    "government_document_supertype": {
      "description": "Document supertype grouping intended to power the Whitehall finders and email subscriptions",
      "type": "string"
    },
    "govuk_request_id": {
      "$ref": "#/definitions/govuk_request_id"
    },
    "links": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "finder": {
          "description": "Powers links from content back to finders the content is surfaced on",
          "$ref": "#/definitions/guid_list"
        },
        "government": {
          "description": "The government associated with this document",
          "$ref": "#/definitions/guid_list",
          "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/guid_list"
        },
        "mainstream_browse_pages": {
          "description": "Powers the /browse section of the site. These are known as sections in some legacy apps.",
          "$ref": "#/definitions/guid_list"
        },
        "meets_user_needs": {
          "description": "The user needs this piece of content meets.",
          "$ref": "#/definitions/guid_list"
        },
        "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/guid_list"
        },
        "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/guid_list"
        },
        "organisations": {
          "description": "All organisations linked to this content item. This should include lead organisations.",
          "$ref": "#/definitions/guid_list"
        },
        "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/guid_list"
        },
        "parent": {
          "description": "The parent content item.",
          "$ref": "#/definitions/guid_list",
          "maxItems": 1
        },
        "policy_areas": {
          "description": "A largely deprecated tag currently only used to power email alerts.",
          "$ref": "#/definitions/guid_list"
        },
        "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/guid_list",
          "maxItems": 1
        },
        "related_policies": {
          "$ref": "#/definitions/guid_list"
        },
        "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/guid_list"
        },
        "taxons": {
          "description": "Prototype-stage taxonomy label for this content item",
          "$ref": "#/definitions/guid_list"
        },
        "topics": {
          "description": "Powers the /topic section of the site. These are known as specialist sectors in some legacy apps.",
          "$ref": "#/definitions/guid_list"
        },
        "world_locations": {
          "$ref": "#/definitions/guid_list"
        },
        "worldwide_organisations": {
          "$ref": "#/definitions/guid_list"
        }
      }
    },
    "locale": {
      "$ref": "#/definitions/locale"
    },
    "navigation_document_supertype": {
      "description": "Document type grouping powering the new taxonomy-based navigation pages",
      "type": "string"
    },
    "need_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "payload_version": {
      "$ref": "#/definitions/payload_version"
    },
    "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": {
      "$ref": "#/definitions/public_updated_at"
    },
    "publishing_app": {
      "$ref": "#/definitions/publishing_app_name"
    },
    "publishing_request_id": {
      "$ref": "#/definitions/publishing_request_id"
    },
    "redirects": {
      "type": "array",
      "additionalItems": false,
      "items": {
      }
    },
    "rendering_app": {
      "$ref": "#/definitions/rendering_app"
    },
    "routes": {
      "$ref": "#/definitions/routes"
    },
    "schema_name": {
      "type": "string",
      "enum": [
        "case_study"
      ]
    },
    "search_user_need_document_supertype": {
      "description": "Document supertype grouping core and government documents",
      "type": "string"
    },
    "title": {
      "$ref": "#/definitions/title"
    },
    "update_type": {
      "$ref": "#/definitions/update_type"
    },
    "user_journey_document_supertype": {
      "description": "Document type grouping powering analytics of user journeys",
      "type": "string"
    },
    "user_need_document_supertype": {
      "description": "DEPRECATED. Use `content_purpose_document_supertype`.",
      "type": "string"
    },
    "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": [
        "body"
      ],
      "additionalProperties": false,
      "properties": {
        "archive_notice": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "archived_at": {
              "format": "date-time"
            },
            "explanation": {
              "type": "string"
            }
          }
        },
        "body": {
          "$ref": "#/definitions/body"
        },
        "brexit_no_deal_notice": {
          "$ref": "#/definitions/brexit_no_deal_notice"
        },
        "change_history": {
          "$ref": "#/definitions/change_history"
        },
        "emphasised_organisations": {
          "$ref": "#/definitions/emphasised_organisations"
        },
        "first_public_at": {
          "$ref": "#/definitions/first_public_at"
        },
        "format_display_type": {
          "type": "string",
          "enum": [
            "case_study"
          ]
        },
        "image": {
          "$ref": "#/definitions/image"
        },
        "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"
          }
        }
      }
    },
    "govuk_request_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "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}$"
    },
    "guid_list": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/guid"
      },
      "uniqueItems": true
    },
    "image": {
      "type": "object",
      "required": [
        "url"
      ],
      "additionalProperties": false,
      "properties": {
        "alt_text": {
          "type": "string"
        },
        "caption": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "credit": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "high_resolution_url": {
          "description": "URL to a high resolution version of the image, for use by third parties such as Twitter, Facebook or Slack. Used by the machine readable metadata component. Don't use this on user-facing web pages, as it might be very large.",
          "type": "string",
          "format": "uri"
        },
        "url": {
          "description": "URL to the image. The image should be in a suitable resolution for display on the page.",
          "type": "string",
          "format": "uri"
        }
      }
    },
    "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"
      ]
    },
    "payload_version": {
      "description": "Counter to indicate when the payload was generated",
      "type": "integer"
    },
    "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"
        }
      ]
    },
    "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"
      ]
    },
    "route": {
      "type": "object",
      "required": [
        "path",
        "type"
      ],
      "additionalProperties": false,
      "properties": {
        "path": {
          "type": "string"
        },
        "type": {
          "enum": [
            "prefix",
            "exact"
          ]
        }
      }
    },
    "routes": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/route"
      },
      "minItems": 1
    },
    "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"
    },
    "update_type": {
      "enum": [
        "major",
        "minor",
        "republish"
      ]
    },
    "withdrawn_notice": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "explanation": {
          "type": "string"
        },
        "withdrawn_at": {
          "format": "date-time"
        }
      }
    }
  }
}