feat(document-builder): add support for setting extensions inside the info object#3424
Merged
kamilmysliwiec merged 1 commit intonestjs:masterfrom May 5, 2025
Merged
Conversation
679c266 to
9a0745e
Compare
benjGam
approved these changes
May 2, 2025
Tony133
approved these changes
May 3, 2025
Member
|
LGTM |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Currently, the extensions are only allowed at root level of the openapi document. According to the OpenAPI documentation, there are more sections where this extensions can be added.
In my case, I want to add Redocly extensions like the x-logo that is supposed to go inside the info section.
What is the new behavior?
Adds a new parameter to the
addExtensionmethod (default toroot) that also allows setting extensions inside the info section.Does this PR introduce a breaking change?
Other information
OpenApi extensions documentation - https://swagger.io/docs/specification/v3_0/openapi-extensions/
Redocly Info Object documentation - https://redocly.com/docs/redoc/redoc-vendor-extensions#info-object