Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
765 lines (624 sloc) 23.7 KB
{
"all_searchable_text": {
"description": "Special field which searchable text is copied into; similar to the standard `_all` field, but more customisable",
"type": "all_searchable_text_type"
},
"format": {
"description": "This field is less specific than content_store_document_type but is mandatory for every document. May be deprecated in future.",
"type": "identifier"
},
"content_purpose_document_supertype": {
"description": "Grouping for content performance supertypes. See https://github.com/alphagov/govuk_document_types/blob/master/data/supertypes.yml",
"type": "identifier"
},
"content_purpose_supergroup": {
"description": "Grouping for content purpose supergroups. See https://github.com/alphagov/govuk_document_types/blob/master/data/supertypes.yml",
"type": "identifier"
},
"content_purpose_subgroup": {
"description": "Grouping for content purpose subgroups. See https://github.com/alphagov/govuk_document_types/blob/master/data/supertypes.yml",
"type": "identifier"
},
"email_document_supertype": {
"description": "High level group for email subscriptions use to identify publications and announcement. See https://github.com/alphagov/govuk_document_types/blob/master/data/supertypes.yml",
"type": "identifier"
},
"government_document_supertype": {
"description": "Grouping for email subscriptions. See https://github.com/alphagov/govuk_document_types/blob/master/data/supertypes.yml",
"type": "identifier"
},
"navigation_document_supertype": {
"description": "Navigation document type. See https://github.com/alphagov/govuk_document_types/blob/master/data/supertypes.yml",
"type": "identifier"
},
"search_user_need_document_supertype": {
"description": "Grouping for core or government documents. See https://github.com/alphagov/govuk_document_types/blob/master/data/supertypes.yml",
"type": "identifier"
},
"user_journey_document_supertype": {
"description": "Used to distinguish pages used mainly for navigation (finding) from content pages (thing). See https://github.com/alphagov/govuk_document_types/blob/master/data/supertypes.yml",
"type": "identifier"
},
"content_id": {
"description": "The content_id of the item. This will not be present for all items, as most application do not send it.",
"type": "identifier"
},
"title": {
"description": "The page title, as diplayed in internal search results. May differ from the page title tag or top level heading.",
"type": "searchable_sortable_text"
},
"description": {
"description": "A descrition or summary of the page that can be displayed to users in search results.",
"type": "searchable_text"
},
"link": {
"description": "The link to the document. This is usually the path component of the URL of the document, including a leading slash, but sometimes omits the leading slash, and is sometimes an absolute URL of related content which does not appear on GOV.UK",
"type": "identifier"
},
"indexable_content": {
"description": "The main chunk of text that is indexed for the page. This varies by document type/publishing app, and may not be suitable for users to read. HTML tags are stripped out.",
"type": "searchable_text"
},
"popularity": {
"description": "Popularity indicator used to bias search results. A higher number indicates more pageviews. Updated nightly.",
"type": "float"
},
"organisations": {
"description": "The organisations related to this page. This field is copied from the publishing-api. Note that means different things for different formats.",
"type": "identifiers"
},
"organisation_content_ids": {
"description": "As opposed to \"organisations\", this will include the \"content_ids\" of each organisation rather than the slug. It will eventually replace \"organisations\".",
"type": "identifiers"
},
"primary_publishing_organisation": {
"description": "The organisation that published this page. This field is copied from the publishing-api. It is only populated by Whitehall.",
"type": "identifiers"
},
"specialist_sectors": {
"description": "The navigation \"topics\" that the document is assigned to. Nothing to do with \"policy areas\"",
"type": "identifiers"
},
"topic_content_ids": {
"description": "The navigation \"topics\" that the document is assigned to. Nothing to do with \"policy areas\". As opposed to \"specialist_sectors\", this will include the \"content_ids\" of each topic rather than the slug. It will eventually replace \"specialist_sectors\".",
"type": "identifiers"
},
"topical_events": {
"description": "The topical events related to this page. These are \"slug\" identifiers.",
"type": "identifiers"
},
"policies": {
"description": "Policy content related to the page (https://www.gov.uk/government/policies).",
"type": "identifiers"
},
"publishing_app": {
"description": "Application that published this page",
"type": "identifier"
},
"policy_areas": {
"description": "Policy areas are managed in Whitehall. They're an old grouping of policies, which we're expecting to deprecate soon. Formally known as 'topics'.",
"type": "identifiers"
},
"rendering_app": {
"description": "Application that renders this page",
"type": "identifier"
},
"mainstream_browse_pages": {
"description": "Mainstream browse pages the page can appear in (https://www.gov.uk/browse).",
"type": "identifiers"
},
"mainstream_browse_page_content_ids": {
"description": "As opposed to \"mainstream_browse_pages\", this will include the \"content_ids\" of each mainstream browse pagerather than the slug. It will eventually replace \"mainstream_browse_pages\".",
"type": "identifiers"
},
"taxons": {
"description": "Topics associated with the page. Used for topic pages (e.g. https://www.gov.uk/education).",
"type": "identifiers"
},
"part_of_taxonomy_tree": {
"description": "Any taxon tagged to the document and any of their ancestor taxons",
"type": "identifiers"
},
"updated_at": {
"description": "When the page was last updated. This field is unreliable and may be deprecated in a future version.",
"type": "date"
},
"public_timestamp": {
"description": "Time of the last update. Used for 1) weighting more recent editions (mainly whitehall content) more highly, 2) the default sort in finders, 3) showing a date in the search results. Should be the same as `public_updated_at` in the publishing-api.",
"type": "date"
},
"first_published_at": {
"description": "The date the content was first published. Should be the same as `first_published_at` in the publishing-api.",
"type": "date"
},
"start_date": {
"type": "date",
"description": "Start date for topical content."
},
"end_date": {
"type": "date",
"description": "End date for topical content. Assume null means in the past for topical event pages."
},
"closed_at": {
"type": "date",
"description": "Closing date for closed organisations."
},
"latest_change_note": {
"description": "Note indicating what changed in the last major revision.",
"type": "unsearchable_text"
},
"id": {
"description": "This field will be deprecated in a future version. Do not use.",
"type": "identifier"
},
"acronym": {
"description": "Acronym associated with the page title. Used for organisation pages.",
"type": "searchable_text"
},
"analytics_identifier": {
"description": "A unique identifier used for analytics.",
"type": "identifier"
},
"attachments": {
"description": "Metadata associated with any attachments linked to this page.",
"type": "objects",
"children": {
"content": { "type": "searchable_text" },
"title": { "type": "searchable_text" },
"isbn": { "type": "searchable_identifier" },
"unique_reference": { "type": "searchable_identifier" },
"command_paper_number": { "type": "searchable_identifier" },
"hoc_paper_number": { "type": "searchable_identifier" }
}
},
"detailed_format": {
"description": "A slugified version of the display_type field",
"type": "identifier"
},
"display_type": {
"description": "Different way of describing content_store_document_type, for some formats. May be deprecated in a future version.",
"type": "identifier"
},
"document_collections": {
"description": "Document collections this page belongs to (https://docs.publishing.service.gov.uk/document-types/document_collection.html).",
"type": "identifiers"
},
"document_series": {
"description": "",
"type": "identifiers"
},
"image_url": {
"description": "The URL of the image associated with an edition",
"type": "identifier"
},
"release_timestamp": {
"description": "When statistics will be released, for statistics announcement pages.",
"type": "date"
},
"metadata": {
"description": "The \"metadata\" field is intended for the storage of additional non-searchable document data. This allows additional information to be stored and displayed in search results without having to make changes to the schema.",
"type": "opaque_object"
},
"operational_field": {
"description": "The place a fatality notice applies to.",
"type": "identifier"
},
"child_organisations": {
"description": "A list of organisations that are children of the organisation.",
"type": "identifiers"
},
"parent_organisations": {
"description": "A list of organisations that are parents of the organisation.",
"type": "identifiers"
},
"superseded_organisations": {
"description": "A list of organisations that are superseded by the organisation.",
"type": "identifiers"
},
"superseding_organisations": {
"description": "A list of organisations that supersede the organisation.",
"type": "identifiers"
},
"organisation_brand": {
"description": "The branding (controls the colour) of the organisation logo",
"type": "identifier"
},
"organisation_crest": {
"description": "The class name of the crest to display when rendering the organisation logo",
"type": "identifier"
},
"organisation_state": {
"description": "Status of an organisation page on GOV.UK: {live, joining, exempt, transitioning, closed, devolved}",
"type": "identifier"
},
"organisation_closed_state": {
"description": "Status of a closed organisation page on GOV.UK: {no_longer_exists, replaced, split, merged, changed_name, left_gov, devolved}",
"type": "identifier"
},
"organisation_type": {
"description": "The organisation type identifier, like 'ministerial_department' or 'public_corporation'. Only applies to organisations. Expected value is the `organisation_type_key` from Whitehall, enumerated in https://github.com/alphagov/whitehall/blob/master/app/models/organisation_type.rb.",
"type": "identifier"
},
"people": {
"description": "Links to people associated with this page (https://www.gov.uk/government/people).",
"type": "identifiers"
},
"policy_groups": {
"description": "Links to policy groups (working groups) associated with this page (https://www.gov.uk/government/groups).",
"type": "identifiers"
},
"relevant_to_local_government": {
"description": "No longer used. Will be removed in a future version.",
"type": "boolean"
},
"search_format_types": {
"description": "Filters used by publications/announcement pages (https://www.gov.uk/government/publications/). May be deprecated in a future version.",
"type": "identifiers"
},
"slug": {
"description": "The trailing part of the link. Two slugs belonging to the same format must be unique.",
"type": "identifier"
},
"statistics_announcement_state": {
"description": "State of a statistical announcement page; one of {cancelled, confirmed, provisional}",
"type": "identifier"
},
"world_locations": {
"description": "World location associated with this page (https://www.gov.uk/world).",
"type": "identifiers"
},
"has_official_document": {
"description": "Used for official document status filter on publication page (publication formats only).",
"type": "boolean"
},
"has_command_paper": {
"description": "Used for official document status filter on publication page (publication formats only).",
"type": "boolean"
},
"has_act_paper": {
"description": "Used for official document status filter on publication page (publication formats only).",
"type": "boolean"
},
"aircraft_category": {
"description": "Used for official document status filter on publication page (publication formats only).",
"type": "identifiers"
},
"report_type": {
"description": "Report type for MAIB, RAIB, AAIB reports. Possible values vary by format.",
"type": "identifiers"
},
"date_of_occurrence": {
"description": "Date of the event described in the document. Only applies to MAIB, RAIB, AAIB reports.",
"type": "date"
},
"registration": {
"description": "Metadata associated with an AAIB report (https://www.gov.uk/aaib-reports/)",
"type": "searchable_text"
},
"aircraft_type": {
"description": "Metadata associated with an AAIB report (https://www.gov.uk/aaib-reports/)",
"type": "searchable_text"
},
"location": {
"description": "Location metadata. Not comparable between different formats.",
"type": "identifiers"
},
"case_type": {
"description": "Similar to report_type: applies to CMA cases.",
"type": "identifiers"
},
"case_state": {
"description": "Whether a case is open or closed. Applies to CMA cases.",
"type": "identifiers"
},
"country": {
"description": "Country associated with the page. Does not link to a page on GOV.UK. See also 'world_locations'.",
"type": "identifiers"
},
"market_sector": {
"description": "Market sector a CMA case relates to.",
"type": "identifiers"
},
"outcome_type": {
"description": "Outcome of a CMA case.",
"type": "identifier"
},
"opened_date": {
"description": "Open date of a CMA case",
"type": "date"
},
"closed_date": {
"description": "Close date of a CMA case",
"type": "date"
},
"contact_groups": {
"description": "Contact groups a 'contact' page belongs to.",
"type": "identifiers"
},
"grant_type": {
"description": "Countryside stewardship grant type (https://www.gov.uk/countryside-stewardship-grants).",
"type": "identifiers"
},
"land_use": {
"description": "Countryside stewardship grant land use type (https://www.gov.uk/countryside-stewardship-grants).",
"type": "identifiers"
},
"tiers_or_standalone_items": {
"description": "Countryside stewardship grant land tiers or standalone items (https://www.gov.uk/countryside-stewardship-grants).",
"type": "identifiers"
},
"funding_amount": {
"description": "Funding (per unit per year)",
"type": "identifiers"
},
"therapeutic_area": {
"description": "Therapeutic area (https://www.gov.uk/drug-safety-update).",
"type": "identifiers"
},
"fund_state": {
"type": "identifiers"
},
"fund_type": {
"type": "identifiers"
},
"funding_source": {
"type": "identifiers"
},
"closing_date": {
"type": "date"
},
"logo_formatted_title": {
"description": "The title (with line breaks) to be displayed alongside the organisation logo",
"type": "identifier"
},
"logo_url": {
"description": "The url of the custom logo - applies to organisations with a custom logo",
"type": "identifier"
},
"manual": {
"type": "identifier",
"description": "Base path of the manual this document belongs to. Eg `/service-manual` or `/hmrc-internal-manuals/air-passenger-duty`"
},
"hmrc_manual_section_id": {
"type": "identifier"
},
"development_sector": {
"type": "identifiers"
},
"eligible_entities": {
"type": "identifiers"
},
"value_of_funding": {
"type": "identifiers"
},
"vessel_type": {
"type": "identifiers"
},
"alert_type": {
"type": "identifiers"
},
"medical_specialism": {
"type": "identifiers"
},
"issued_date": {
"type": "date"
},
"railway_type": {
"type": "identifiers"
},
"is_political": {
"description": "If the content is considered political in nature, reflecting views of the government it was published under",
"type": "boolean"
},
"is_historic": {
"description": "If the content is political and published by a previous government, it is considered historic and not reflecting of the current government",
"type": "boolean"
},
"is_withdrawn": {
"description": "If the content has been published but then withdrawn",
"type": "boolean"
},
"government_name": {
"description": "The name of the Government that first published this document, eg, '1970 to 1974 Conservative government'",
"type": "unsearchable_text"
},
"exact_query": {
"description": "Field used in the best-bet implementation to perform an exact match between a user's query and a stored best-bet",
"type": "best_bet_exact_match_text"
},
"stemmed_query": {
"description": "Field used in the best-bet implementation to perform a stemmed match between a user's query and a stored best-bet",
"type": "best_bet_stemmed_match_text"
},
"stemmed_query_as_term": {
"description": "Field used in the best-bet implementation to hold the raw form of a stemmed query",
"type": "identifier"
},
"details": {
"description": "Field used in the best-bet implementation to store the modifications to be made to the query when a best-bet is matched",
"type": "unsearchable_text"
},
"path_components": {
"description": "Field used in the page-traffic index to hold the full paths of each component of a url. eg: a document with a path of '/foo/bar/baz' would have the values '/foo', '/foo/bar' and '/foo/bar/baz' in this field. This allows all the pages under a given URL component to be identified.",
"type": "identifiers"
},
"rank_14": {
"description": "Field used in the page-traffic index to hold the rank of this page in the list of pages on the website when ordered by traffic. This is a fairly stable value used in ranking calculations.",
"type": "float"
},
"spelling_text": {
"description": "Generated field, populated with the same content as sent to the _all field, but tokenised into words, lowercased and shingled, not stemmed, etc",
"type": "spelling_text"
},
"important_to_policy": {
"description": "A flag set by editors to mark a document as being important to policy",
"type": "boolean"
},
"tribunal_decision_categories": {
"type": "identifiers"
},
"tribunal_decision_categories_name": {
"type": "searchable_identifiers"
},
"tribunal_decision_country": {
"type": "identifier"
},
"tribunal_decision_country_name": {
"type": "searchable_identifier"
},
"tribunal_decision_decision_date": {
"type": "date"
},
"tribunal_decision_judges": {
"type": "identifiers"
},
"tribunal_decision_judges_name": {
"type": "searchable_identifiers"
},
"tribunal_decision_category": {
"type": "identifier"
},
"tribunal_decision_category_name": {
"type": "searchable_identifier"
},
"tribunal_decision_sub_category": {
"type": "identifier"
},
"tribunal_decision_sub_category_name": {
"type": "searchable_identifier"
},
"tribunal_decision_sub_categories": {
"type": "identifiers"
},
"tribunal_decision_sub_categories_name": {
"type": "searchable_identifiers"
},
"tribunal_decision_landmark": {
"type": "identifier"
},
"tribunal_decision_landmark_name": {
"type": "searchable_identifier"
},
"tribunal_decision_reference_number": {
"type": "identifier"
},
"dfid_authors": {
"description": "A set of author names, which aren't selected from a predefined list and don't repeat",
"type": "searchable_identifiers"
},
"dfid_review_status": {
"description": "Whether or not this item is peer reviewed (a code)",
"type": "identifier"
},
"dfid_theme": {
"description": "The broad theme (or themes) to which the output applies",
"type": "searchable_identifiers"
},
"dfid_document_type": {
"description": "The document type of the output (e.g. Book Chapter, Conference Paper)",
"type": "searchable_identifier"
},
"assessment_date": {
"description": "The date when the assessment was held.",
"type": "date"
},
"content_store_document_type": {
"description": "The document type as stored in the Content Store",
"type": "identifier"
},
"business_sizes": {
"description": "The sizes of business served by a business finance support scheme",
"type": "searchable_identifiers"
},
"business_stages": {
"description": "The stages of business served by a business finance support scheme",
"type": "searchable_identifiers"
},
"industries": {
"description": "The industries served by a business finance support scheme",
"type": "searchable_identifiers"
},
"regions": {
"description": "The regions served by a business finance support scheme",
"type": "searchable_identifiers"
},
"types_of_support": {
"description": "The types of support provided by a business finance support scheme",
"type": "searchable_identifiers"
},
"licence_identifier": {
"description": "The licence ID associated with a content item of type licence",
"type": "identifier"
},
"licence_short_description": {
"type": "searchable_text"
},
"sifting_status": {
"description": "The open/close/etc state of a statutory instrument",
"type": "identifiers"
},
"subject": {
"description": "The associated top level taxon for statutory instruments",
"type": "identifiers"
},
"laid_date": {
"description": "The date on which a statutory instrument was laid before parliament",
"type": "date"
},
"sift_end_date": {
"description": "The date on which sifting of a statutory instrument ends",
"type": "date"
},
"withdrawn_date": {
"description": "The date on which a statutory instrument was withdrawn",
"type": "date"
},
"certificate_status": {
"description": "The active/on-hold state of the certificate",
"type": "identifiers"
},
"commodity_type": {
"description": "The type of the commodity being exported",
"type": "identifier"
},
"destination_country": {
"description": "The country being exported to",
"type": "identifiers"
},
"appear_in_find_eu_exit_guidance_business_finder": {
"description": "Flag to control if this document should appear in the finder, as it is not restricted by document type.",
"type": "identifier"
},
"sector_business_area": {
"description": "The sector or business area",
"type": "identifiers"
},
"employ_eu_citizens": {
"description": "Whether or not the EU citizens are employed",
"type": "identifiers"
},
"business_activity": {
"description": "Whether or not the going concern does business in the EU and their type of business (e.g. buying, selling, transporting)",
"type": "identifiers"
},
"regulations_and_standards": {
"description": "Regulations that apply to the business",
"type": "identifiers"
},
"personal_data": {
"description": "The type of personal data processing the organisation handles",
"type": "identifiers"
},
"intellectual_property": {
"description": "The type of intellectual property a business holds",
"type": "identifiers"
},
"eu_uk_government_funding": {
"description": "The EU scheme from which the business receives its funding",
"type": "identifiers"
},
"public_sector_procurement": {
"description": "The public sector body that procures goods or services",
"type": "identifiers"
}
}