fix(schema): preserve example metadata for non-body params with named types#3782
Open
maruthang wants to merge 1 commit intonestjs:masterfrom
Open
fix(schema): preserve example metadata for non-body params with named types#3782maruthang wants to merge 1 commit intonestjs:masterfrom
maruthang wants to merge 1 commit intonestjs:masterfrom
Conversation
… types When a non-body parameter (query/param/header) has a named type and schema-level options like example, those options were lost because getCustomType placed them at the top level while SwaggerTypesMapper stripped them. Move schema options into the schema object using allOf pattern when a $ref is present. Closes nestjs#3335
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.
PR Checklist
PR Type
What is the current behavior?
When a ParentDto has a property of type ChildDto, and both have
@ApiProperty({ example: ... }), the parent'sexampleis lost for non-body parameters (@query, @param, @headers). The child DTO's examples leak through instead.This happens because
getCustomType()places schema-level options (likeexample) at the top level of the parameter object, whileSwaggerTypesMapper.mapParamTypes()later strips all schema-option keys from the top level.Issue Number: #3335
What is the new behavior?
Schema-level options (example, default, format, etc.) are now moved into the
schemaobject aftergetCustomType()returns. When there are extra metadata properties alongside a$ref, it uses theallOf: [{ $ref }]pattern, ensuring metadata is properly preserved for all parameter types.Does this PR introduce a breaking change?