-
-
Notifications
You must be signed in to change notification settings - Fork 505
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Obey annotations when flattening ParameterObject fields. Fixes #2787
When creating the flattened parameter definitions for an item annotated with `@ParameterObject`, the `@Schema` and `@Property` annotations on any fields prior to the final child-node of each branch of the parameter tree are not taken into consideration. This results in the field name in the code being used even where annotations may override that, prevents the fields being hidden where one of the parent fields is marked as hidden but the child field isn't hidden, and marks a field as mandatory even where the field would only be mandatory if the parent object had been declared through a sibling of the target field being set. To overcome this, whilst the flattened parameter map is being built, each field is now being inspected for a `@Parameter` annotation or - where the `@Parameter` annotation isn't found - a `@Schema` annotation. Where a custom name is included in either of those annotations then the overridden field name is used in the flattened definition. If either annotation declares the field as hidden then the field and all child fields are removed from the resulting definition, and a field is no longer set as mandatory unless the parent field was also declared as mandatory, or resolved as non-null and was set in an automatic state. To ensure that the post-processing steps don't re-apply `required` properties on parameters that have purposefully had them removed, the delegate now tracks any annotations what should not be shown as being on the parameter, and excludes them from the annotation list during subsequent calls.
- Loading branch information
Showing
6 changed files
with
369 additions
and
18 deletions.
There are no files selected for viewing
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
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
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
86 changes: 86 additions & 0 deletions
86
...arter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app232/ParameterController.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| /* | ||
| * | ||
| * * | ||
| * * * | ||
| * * * * | ||
| * * * * * | ||
| * * * * * * Copyright 2019-2024 the original author or authors. | ||
| * * * * * * | ||
| * * * * * * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * * * * * * you may not use this file except in compliance with the License. | ||
| * * * * * * You may obtain a copy of the License at | ||
| * * * * * * | ||
| * * * * * * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * * * * * * | ||
| * * * * * * Unless required by applicable law or agreed to in writing, software | ||
| * * * * * * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * * * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * * * * * * See the License for the specific language governing permissions and | ||
| * * * * * * limitations under the License. | ||
| * * * * * | ||
| * * * * | ||
| * * * | ||
| * * | ||
| * | ||
| */ | ||
| package test.org.springdoc.api.v30.app232; | ||
|
|
||
| import io.swagger.v3.oas.annotations.Parameter; | ||
| import io.swagger.v3.oas.annotations.media.Schema; | ||
| import jakarta.validation.constraints.NotNull; | ||
| import org.springdoc.core.annotations.ParameterObject; | ||
|
|
||
| import org.springframework.web.bind.annotation.GetMapping; | ||
| import org.springframework.web.bind.annotation.RestController; | ||
|
|
||
| @RestController | ||
| public class ParameterController { | ||
|
|
||
| @GetMapping("/hidden-parent") | ||
| public void nestedParameterObjectWithHiddenParentField(@ParameterObject ParameterObjectWithHiddenField parameters) { | ||
|
|
||
| } | ||
|
|
||
| public record ParameterObjectWithHiddenField( | ||
| @Schema(hidden = true) NestedParameterObject schemaHiddenNestedParameterObject, | ||
| @Parameter(hidden = true) NestedParameterObject parameterHiddenNestedParameterObject, | ||
| NestedParameterObject visibleNestedParameterObject | ||
| ) { | ||
|
|
||
| } | ||
|
|
||
| public record NestedParameterObject( | ||
| String parameterField) { | ||
| } | ||
|
|
||
| @GetMapping("/renamed-parent") | ||
| public void nestedParameterObjectWithRenamedParentField(@ParameterObject ParameterObjectWithRenamedField parameters) { | ||
|
|
||
| } | ||
|
|
||
| public record ParameterObjectWithRenamedField( | ||
| @Schema(name = "schemaRenamed") NestedParameterObject schemaRenamedNestedParameterObject, | ||
| @Parameter(name = "parameterRenamed") NestedParameterObject parameterRenamedNestedParameterObject, | ||
| NestedParameterObject originalNameNestedParameterObject | ||
| ) { | ||
|
|
||
| } | ||
|
|
||
| @GetMapping("/optional-parent") | ||
| public void nestedParameterObjectWithOptionalParentField(@ParameterObject ParameterObjectWithOptionalField parameters) { | ||
|
|
||
| } | ||
|
|
||
| public record ParameterObjectWithOptionalField( | ||
| @Schema(requiredMode = Schema.RequiredMode.NOT_REQUIRED) NestedRequiredParameterObject schemaNotRequiredNestedParameterObject, | ||
| @Parameter NestedRequiredParameterObject parameterNotRequiredNestedParameterObject, | ||
| @Parameter(required = true) NestedRequiredParameterObject requiredNestedParameterObject | ||
| ) { | ||
|
|
||
| } | ||
|
|
||
| public record NestedRequiredParameterObject( | ||
| @Schema(requiredMode = Schema.RequiredMode.REQUIRED) @NotNull String requiredParameterField) { | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.