feat: render NodeVendorExtensions in the 'overview' page #2815
Conversation
This file contains hidden or 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
✅ Deploy Preview for stoplight-elements ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for stoplight-elements-demo ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
steven-noorbergen
force-pushed
the
add-overview-vendor-extensions
branch
from
2db7d5e to
898ea64
Compare
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
This inserts a NodeVendorExtensions into the HttpService component, allowing one to render information based on extensions put on the root node.
Why
We are working on replacing our Swagger UI with Elements. While we are extremely impressed with Elements, we wanted to put some extension information in our Overview page, but the HttpService never calls NodeVendorExtensions to allow this.
Impact
This reuses existing flows, so the addons you pass to renderExtensionAddon will automatically get called if/when you add extensions to the root of your spec document. If none are set - which I expect the majority of users will have, NodeVendorExtensions doesn't render, keeping original behavior.
Elements Default PR Template
In general, make sure you have: (check the boxes to acknowledge you've followed this template)
CONTRIBUTING.mdOther Available PR Templates:
CONTRIBUTING.md