feat: support adding custom fields on the servers[*] entry#3715
Merged
kamilmysliwiec merged 3 commits intonestjs:masterfrom Feb 4, 2026
Merged
feat: support adding custom fields on the servers[*] entry#3715kamilmysliwiec merged 3 commits intonestjs:masterfrom
servers[*] entry#3715kamilmysliwiec merged 3 commits intonestjs:masterfrom
Conversation
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
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?
While using the Cloud Endpoints service from Google Cloud, I notice that the document query builder on
@nestjs/swaggerdid not support the following feature of CE: https://docs.cloud.google.com/endpoints/docs/openapi/oasv3-extensions?#x-google-endpointbecause we can't add custom fields to the
servers[*]entry -- thex-google-endpoint, for example.There is a way to circumvent that limitation but it looks hacky.
What is the new behavior?
The
.addServernow supports a new parameter dedicated for custom attributes for each entry in theserversfield of OpenAPI v3. Note that I'm not a fan of having 4 parameters but this was the only way to avoid breaking changes - we could improve that in the next major version.will output the following:
Does this PR introduce a breaking change?