WPP-11527 API Spec HTML export workflow

[edwardbowyer-nhs]

Summary

WPP-11527 - API Spec HTML export workflow

• Added workflow which Builds, Dereferences and Generates static HTML views of the specs. These are to be socialise potential changes with stakeholders for feedback. The workflow can be run directly from branch or upon a successful merge into master.
• Specs fully dereferenced to ensure examples are fully viewable to provide most value.

Reviews Required

• Dev
• Test
• Tech Author
• Product Owner

Review Checklist

ℹ️ This section is to be filled in by the reviewer.

• I have reviewed the changes in this PR and they fill all or part of the acceptance criteria of the ticket, and the code is in a mergeable state.
• If there were infrastructure, operational, or build changes, I have made sure there is sufficient evidence that the changes will work.
• I have ensured the changelog has been updated by the submitter, if necessary.

[github-actions]

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

APM-000

[Copilot]

Pull request overview

Adds a GitHub Actions workflow to generate and export static HTML renderings of the API OpenAPI specs for stakeholder review, and updates repository documentation to reflect the current specification toolchain.

Changes:

• Added a workflow to publish bundled specs, dereference them, and generate static Redocly HTML pages as a downloadable artifact.
• Updated README to describe current OpenAPI tooling (OpenAPI Generator + Redocly) and npm scripts (lint, publish).
• Updated Swagger UI caveat guidance to prefer bundled specs/static docs for review.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
README.md	Updates spec-tooling documentation and guidance to match current scripts/tooling.
.github/workflows/build-api-spec-html.yml	New workflow to build/dereference specs and generate/upload static HTML docs artifacts.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[github-actions]

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

APM-000

[github-actions]

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

APM-000

[github-actions]

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

APM-000

[github-actions]

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

APM-000

[github-actions]

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

APM-000

[github-actions]

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

APM-000

[github-actions]

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

APM-000

[simeonparris-nhs]

Thanks for answering my questions. This all looks good as far as I can tell.