Application: content-store

API for content on GOV.UK

• GitHub: content-store
• Ownership: #govuk-publishing-platform
• Hosting: AWS, on the content_store machine class
• Category: APIs
• Rake tasks: Run a Rake task on Integration, Staging or ⚠️ Production ⚠️
• Links:
  • www.gov.uk/api/content
  • Sentry (error tracking)
  • Puppet configuration
  • Deploy scripts
  • Deployment dashboard

Imported documents

• # Gone items
• # Placeholder items
• # Redirect items
• # Registering routes with the router.
• Access-limited content items
• Content Item Fields
• Content Store API
• Publish intents
• /output_examples/frontend-app
• basic_formats
• find_my_nearest
• licence
• local_transaction
• travel-advice-country
• travel-advice-index

README

The Content Store is a MongoDB database of almost all published content on GOV.UK. See the Content Store API for basic usage.

Technical documentation

This is a Ruby on Rails app, and should follow our Rails app conventions.

You can use the GOV.UK Docker environment to run the application and its tests with all the necessary dependencies. Follow the usage instructions to get started.

Use GOV.UK Docker to run any commands that follow.

Running the test suite

bundle exec rake

Example API output

Example API requests and corresponding responses can be found in the content store pact-broker documentation.

Further documentation

• Content Store API
• Publish intents
• Access-limited content items
• Content item fields
• Gone items
• Redirect items
• Placeholder items

Licence

MIT License