cmsnav-747 Update OAS spec., sandbox examples#157
Merged
mcheung-nhs merged 1 commit intomasterfrom Apr 22, 2025
Merged
Conversation
5eed4a6 to
051fd26
Compare
mcheung-nhs
previously approved these changes
Apr 17, 2025
Contributor
mcheung-nhs
left a comment
There was a problem hiding this comment.
Have previewed the YAML file and it looks fine to me.
051fd26 to
ed5bbf4
Compare
mcheung-nhs
approved these changes
Apr 17, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Review Checklist
ℹ️ This section is to be filled in by the reviewer.