Skip to content

Feature/cmsnav 823#159

Merged
pflynny merged 6 commits intomasterfrom
feature/cmsnav-823
Jun 18, 2025
Merged

Feature/cmsnav 823#159
pflynny merged 6 commits intomasterfrom
feature/cmsnav-823

Conversation

@pflynny
Copy link
Contributor

@pflynny pflynny commented Jun 16, 2025

Summary

  • 🤖 Operational or Infrastructure Change
    Add documentation for new endpoints (health-a-to-z, health-a-to-z/conditions, baby and social-care-and-support)

The changes fall into several categories:

Sandbox

The Sandbox is a mock of the API - a simple JS application that offers canned responses to a selection of API endpoints.
Some of the responses have changed (because of content changes) and we needed new ones to showcase the new endpoints.

API documentation

The yaml file defines the material that will be presented as the API documentation pages in the developer portal. This will be published by the APIM team when we have merged our changes.

The yaml file can be previewed if you build the publishing system locally.

Examples

In the API documentation we link to numerous examples of output from the API. We needed to modify the example for the conditions endpoint and to add examples for the new endpoints.

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.

@pflynny pflynny requested a review from mcheung-nhs June 16, 2025 12:52
Copy link
Contributor

@mcheung-nhs mcheung-nhs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could do with updating the "_curl-commands.txt" and "Sandbox endpoints - localhost.md".

@pflynny pflynny merged commit 69cb748 into master Jun 18, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants