fix: pass along type_use annotations to swagger(-core)#3300
Open
tthornton3-chwy wants to merge 2 commits into
Open
fix: pass along type_use annotations to swagger(-core)#3300tthornton3-chwy wants to merge 2 commits into
tthornton3-chwy wants to merge 2 commits into
Conversation
| * A parameter object whose {@code clinicId} field is reused as both an optional, nullable | ||
| * query parameter and a (required, non-null) path parameter, depending on the controller. | ||
| */ | ||
| class SearchCriteria { |
Contributor
There was a problem hiding this comment.
What is the reason for wanting reuse this object in different contexts where @Nullable is not always correct? For the case where it is used in a path-parameter context, then the annotation misleads the consumer using the object, since the object says nullable but it actually is required?
Isn't the better approach to have an object specifically for the path scenario, so that it both documents the nullable correctly inwards and outwards?
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.
Summary
Preserve top-level TYPE_USE annotations when Springdoc flattens @ParameterObject fields into query parameters.
Previously, GenericParameterService only forwarded annotations from parameterized type arguments. That meant annotations like JSpecify-style @nullable on an array type, e.g. Status @nullable [] status, were dropped before schema extraction. Swagger-core therefore never saw the nullable signal and generated only type: "array".
This change forwards both:
That allows OpenAPI 3.1 nullable array query parameters to generate:
"type": ["array", "null"]
Change Plan
Test Plan
Ran the test suite with the new tests.