Conversation
@query({schema}) / @PARAM({schema}) built from a Standard Schema (Zod, Valibot, ArkType) only ever set parameter.schema.description, never parameter.description. Swagger UI's parameter table reads the latter, so descriptions silently fail to render for any Standard Schema param, while decorator-based params (@apiquery({description})) work fine because Nest keeps description at the parameter level. Promote schema.description onto the parameter in both places a Standard Schema becomes a parameter (the unnamed-object expansion and the single named-param override), keeping the schema-level copy intact. An explicit @ApiParam/@apiquery description still wins, since it is merged onto the parameter before this runs. Closes nestjs#4139
4 tasks
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
1 participant
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.
@query({schema}) / @PARAM({schema}) built from a Standard Schema (Zod, Valibot, ArkType) only ever set parameter.schema.description, never parameter.description. Swagger UI's parameter table reads the latter, so descriptions silently fail to render for any Standard Schema param, while decorator-based params (@apiquery({description})) work fine because Nest keeps description at the parameter level.
Promote schema.description onto the parameter in both places a Standard Schema becomes a parameter (the unnamed-object expansion and the single named-param override), keeping the schema-level copy intact. An explicit @ApiParam/@apiquery description still wins, since it is merged onto the parameter before this runs.
Closes #4139
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?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information