OpenAPI: add pagination and make feed valid #42
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
Optional path strings are not a part of the OpenAPI spec but have been a long-running request. OAI/OpenAPI-Specification#93 So we tell a small fib in the spec and say these paths are required, (because they *have* to be required in the spec) but then have a comment pointing out that /atom.xml etc are valid paths. Additionally we add some scripts to install an OpenAPI validator and to validate the two YAML documents. There is documentation for doing this with pre-commit but I couldn't get that to work.
Also bumped version number, because this is a meaningful backwards compatible difference to the public description of the feed.
Floppy
approved these changes
Jun 21, 2022
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.
Trello Ticket
We used an optional path string in the OpenAPI spec but they don't actually exist.
Optional path strings are not a part of the OpenAPI spec but
have been a long-running request.
OAI/OpenAPI-Specification#93
So we tell a small fib in the spec and say these paths are required,
(because they have to be required in the spec) but then
have a comment pointing out that /atom.xml etc are valid paths.
Additionally we add some scripts to install an OpenAPI validator
and to validate the two YAML documents. There is documentation
for doing this with pre-commit but I couldn't get that to work.