Skip to content

cmsnav-747 Update OAS spec., sandbox examples#157

Merged
mcheung-nhs merged 1 commit intomasterfrom
feature/cmsnav-747-minimal
Apr 22, 2025
Merged

cmsnav-747 Update OAS spec., sandbox examples#157
mcheung-nhs merged 1 commit intomasterfrom
feature/cmsnav-747-minimal

Conversation

@angloc
Copy link
Copy Markdown
Contributor

@angloc angloc commented Apr 17, 2025

Summary

Add documentation for new endpoints (symptoms and tests-and-treatments)

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. Unfortunately this is not working in the present sources and the fixes have been deferred to simplify the delivery of this ticket.

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 two 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.

@mcheung-nhs mcheung-nhs force-pushed the feature/cmsnav-747-minimal branch 2 times, most recently from 5eed4a6 to 051fd26 Compare April 17, 2025 13:18
mcheung-nhs
mcheung-nhs previously approved these changes Apr 17, 2025
Copy link
Copy Markdown
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.

Have previewed the YAML file and it looks fine to me.

@mcheung-nhs mcheung-nhs force-pushed the feature/cmsnav-747-minimal branch from 051fd26 to ed5bbf4 Compare April 17, 2025 15:06
@mcheung-nhs mcheung-nhs self-requested a review April 17, 2025 15:19
@mcheung-nhs mcheung-nhs merged commit b2b94db into master Apr 22, 2025
5 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