feat(decorators): add style and explode options to @ApiProperty#3789
Open
JadenKim-dev wants to merge 1 commit intonestjs:masterfrom
Open
feat(decorators): add style and explode options to @ApiProperty#3789JadenKim-dev wants to merge 1 commit intonestjs:masterfrom
JadenKim-dev wants to merge 1 commit intonestjs:masterfrom
Conversation
Add `style` and `explode` properties to `ApiPropertyCommonOptions`, allowing nested object query parameters to be serialized using OpenAPI serialization styles such as `deepObject`.
1 task
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?
@ApiPropertydoes not acceptstyleorexplodeoptions. When using a nested object as a query parameter (e.g.Geolocationinside aQueryDto), there is no way to specifystyle: 'deepObject'without a@ts-expect-errorworkaround.This causes Swagger UI to generate flat query strings like
?latitude=5&longitude=1instead of?geolocation[latitude]=5&geolocation[longitude]=1.Issue Number: #3495
What is the new behavior?
ApiPropertyCommonOptionsnow includes optionalstyle(typed asParameterStyle) andexplode(typed asboolean) properties. These values are passed through to the OpenAPIParameterObjectat the top level, enabling proper serialization of nested query parameters.Example usage:
Does this PR introduce a breaking change?
Other information