Improve OpenAPI generation #893
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
svix-andor
force-pushed
the
andor/openapi-improvements
branch
2 times, most recently
from
f749f1a to
5213494
Compare
* Move OpenAPI related things to its own file * Add operational webhooks docs * EventTypesQueryParams documented
These endpoints only support returning their data in a descending order at the moment. However, the Pagination struct includes an order field, which these handlers ignore.
This is to match the names used in existing documentation.
This is so we can easily get `x-enum-varnames` for our repr-enums.
This way they don't pollute the generated spec
These aren't strictly needed because other extractors provide the same information but they're needed to generate accurate documentation.
svix-andor
force-pushed
the
andor/openapi-improvements
branch
from
5213494 to
e09f773
Compare
6 tasks
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.
This PR contains a series of commits aimed at improving the OpenAPI generation in order to make it closely match our current specification, but now instead generated by Rust. It is best reviewed commit by commit.