Add Callbacks support #691
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
lucasassisrosa
had a problem deploying
to
default
GitHub Actions
Failure
|
Hi @lucasassisrosa, thanks for the contribution. Can you address the linter/unused import error? Thanks! |
lucasassisrosa
had a problem deploying
to
default
GitHub Actions
Failure
|
Visit the preview URL for this PR (updated for commit 980324d): https://docusaurus-openapi-36b86--pr691-y9v5jecd.web.app (expires Thu, 08 Feb 2024 16:11:31 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
sserrata
reviewed
Jan 9, 2024
sserrata
reviewed
Jan 9, 2024
sserrata
reviewed
Jan 9, 2024
There was a problem hiding this comment.
Hi @lucasassisrosa, everything looks solid so far! Please see my comments/questions.
packages/docusaurus-plugin-openapi-docs/src/markdown/createOperationHeader.ts
Outdated
Show resolved
Hide resolved
lucasassisrosa
added a commit
to lucasassisrosa/docusaurus-openapi-docs
that referenced
this pull request
Jan 18, 2024
* add support to callbacks in openapi specs * set package manager in package json * implement operations as tabs within request panel * render callbacks below Request and Responses * remove unwanted files * rename create file * restore json settings
sserrata
pushed a commit
that referenced
this pull request
Jan 18, 2024
* Add Callbacks support (#691) * add support to callbacks in openapi specs * set package manager in package json * implement operations as tabs within request panel * render callbacks below Request and Responses * remove unwanted files * rename create file * restore json settings * convert OperationTabs to typescript * fix linter * fix warning on lint order
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.
Description
OpenAPI specs callbacks in endpoints were being ignored on rendering. I noticed the types were included but no code was found for rendering the callbacks. So
callbacksincluded in Petstore cannot be seen at https://docusaurus-openapi.tryingpan.dev/petstore/subscribe-to-the-store-eventsMotivation and Context
Be aligned with OpenAPI 3.0 Specs: https://swagger.io/docs/specification/callbacks/
How Has This Been Tested?
Go to petstore "Subscribe to the store events" - http://localhost:3000/petstore/subscribe-to-the-store-events
Types of changes
Checklist