Application: hmrc-manuals-api

API for HMRC to publish manuals to GOV.UK

• GitHub: hmrc-manuals-api
• Ownership: #govuk-publishing-platform owns the repo. #govuk-publishing-platform-system-alerts receives automated alerts for this repo.
• Category: APIs
• Links:
  • Sentry (error tracking)
  • App dashboard: request rates, errors, durations
  • Kibana App Logs (Production, last 3 hours)
  • Kibana Worker Logs (Production, last 3 hours)
  • Argo CD (hmrc-manuals-api)

Example pages published by hmrc-manuals-api

• Capital Gains Manual
• IEIM402040 - Reportable Information: Tax Identification Number
• RDRM11500 - Residence: The SRT: The ties tests: Contents
• Pensions Tax Manual
• RDRM12000 - Residence: The SRT: Split year treatment: Contents
• EIM23151 - Car benefit: double cab pickups 6 April 2025 onwards
• RDRM11520 - Residence: The SRT: The number of ties
• RDRM12030 - Residence: The SRT: Split year treatment: When will split year treatment apply
• CISR14330 - The Scheme: construction operations: index of construction operations
• RDRM11530 - Residence: The SRT: Definition of a family tie

README

Provides an API for a system built by HMRC to publish tax manuals onto GOV.UK. In many ways it is analogous to a backend/admin app for publishing on GOV.UK. Content which passes validation and checks for unsanitary content is submitted to the GOV.UK Publishing API application. The application does not have a database itself. An HMRC manual consists of two document types: the manual itself and manual sections.

Nomenclature

• Manual: HMRC manual with title and description, contains many Sections. See Adding or updating a manual for more details.

• Section: Sections can contain sub-sections and/or a content body. See Adding or updating a section for more details.

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 rspec

Manuals and decisions

See the extended documentation for details:

• Connecting to the API
• Adding or updating a manual
• Adding or updating a section
• Responses to PUT requests
• Slugs, Section Ids and Urls
• Content Ids
• Markup
• Manual Tags
• Removing published manuals
• Testing publishing in GOV.UK Docker
• Managing manuals and sections with rake
• Responses to PUT requests

Licence

MIT License