feat(docs): add multiple examples support and webhook schema #1864
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
Narayanbhat166
added
C-doc
There was a problem hiding this comment.
Can we move these to the router crate if it's the only crate accessing it? Maybe a module in the openapi module?
SanchithHegde
added
S-waiting-on-author
Narayanbhat166
added
S-waiting-on-review
jarnura
previously approved these changes
Aug 8, 2023
Narayanbhat166
added
S-ready-for-merge
and removed
S-waiting-on-review
SanchithHegde
added
the
S-waiting-on-author
SanchithHegde
previously approved these changes
Aug 8, 2023
SanchithHegde
added
S-waiting-on-review
SanchithHegde
approved these changes
Aug 8, 2023
jarnura
approved these changes
Aug 8, 2023
jarnura
removed
the
S-waiting-on-review
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.
Type of Change
Description
Add webhooks schema and multiple examples support for openapi.
Motivation and Context
Multiple examples would be needed to convey the right set of fields required to be sent for a particular kind of payment. This Pr adds support to add multiple examples by specifying the examples as a json string in the
openapi_constsfile incommon_utilscrate.How did you test it?
Generate the openapi file and check in any swagger ui availble online.
Checklist
cargo +nightly fmt --allcargo clippy