fix(swagger): improve rendering of array items #3255
Conversation
This file contains 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
ccaspers
changed the title
| ? { type: (items as any).type, ...modifierProperties } | ||
| : { ...(items as any).type, ...modifierProperties } | ||
| ? { type: (items as any).type, ...modifierProperties, ...items } | ||
| : { ...(items as any).type, ...modifierProperties, ...items } |
There was a problem hiding this comment.
...items will override type here (when type is not string)
There was a problem hiding this comment.
That's true. But this will only happen, if the user decided to manually add a type to items like this for example:
@ApiProperty({
items: {
type: 'string',
}
})I would argue that this is the desired behavior, but I'll look into it.
There was a problem hiding this comment.
I have seen this fairly often in the past
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?
When documenting items in arrays,
minLengthandmaxLengthwill not be rendered.Issue Number: #3207
What is the new behavior?
minLengthandmaxLengthcan now be used to document items in arrays.Does this PR introduce a breaking change?
Other information