Add /all endpoint documentation #45
Merged
Conversation
This file contains 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
rcantin-w
reviewed
Dec 17, 2024
rcantin-w
reviewed
Dec 17, 2024
rcantin-w
reviewed
Dec 17, 2024
rcantin-w
reviewed
Dec 17, 2024
gestchild
force-pushed
the
add-all-endpoint
branch
from
cb3d94e to
77d30bd
Compare
gestchild
force-pushed
the
add-all-endpoint
branch
from
a1bbbf2 to
0e90792
Compare
rcantin-w
approved these changes
Jan 6, 2025
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.
What does this change?
For #43
N.B. The content.yaml is getting a bit unwieldy. I did attempt to break the file up and make bits reusable, but I ran into a bug with swagger where it only seems to recognise the first external file used in a $ref. Rather than waste any more time on it I ended up just editing the content.yaml file, but we may want to revisit this again in the future.
How to test
You can run this locally with
yarn start, and look at the new docsHow can we measure success?
It's up to date and useful for anyone we might onboard.
Have we considered potential risks?
N/A