Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.97 KB

content-store-api.md

File metadata and controls

37 lines (24 loc) · 1.97 KB
Raw

Content Store API

Content items

ContentItem is the base unit of content in the content store. They have both a private and public-facing JSON representation.

Writing content items to the content store

Content is written by the publishing API, which is used by back-end publishing apps such as Travel Advice Publisher.

To add or update a piece of content in the content store, make a PUT request:

curl https://content-store.publishing.service.gov.uk/content<base_path> -X PUT \
    -H 'Content-type: application/json' \
    -d '<content_item_json>'

where <base_path> is the path on GOV.UK where the content lives (for example /vat-rates) and <content_item_json> is the JSON for the content item.

Reading content from the content store

Content is retrieved from the content store via the content store, which takes a path and responds with a JSON representation of the content that should be displayed on that path. This API is used by front-end apps but is also exposed externally at /api/content/<path>, such as https://www.gov.uk/api/content/take-pet-abroad

To retrieve content from the content store, make a GET request:

  curl https://content-store.publishing.service.gov.uk/content<path>

If the path matches a base_path content will be returned, whereas if the path matches a route a 303 redirect will be returned to the content at the base_path.

Not all content exists as a standalone page like the /take-pet-abroad example. Some content exists as a collection that references other pieces of content, and some content exists as meta content designed to describe a wider whole. We use content-schemas defined in publishing api to describe all these different content types. The content API itself is not prescriptive about this; it takes any JSON structure.