-
-
Notifications
You must be signed in to change notification settings - Fork 589
Javadoc Descriptions Lost When Using @JsonProperty for Property Name Change in springdoc-openapi #2438
Copy link
Copy link
Closed
Labels
enhancementNew feature or requestNew feature or request
Description
Describe the bug
When using @JsonProperty to change the property name, the Javadoc description is lost in the OpenAPI documentation generated by springdoc-openapi.
To Reproduce
Steps to reproduce the behavior:
- Spring Boot version: 3.2.0
- springdoc-openapi version: 2.2.0
- Actual and expected result using OpenAPI Description (yml or json): [Include actual and expected OpenAPI descriptions]
- Sample code (TestController or similar) or Test that reproduces the problem:
@RestController
public class TestController {
@PostMapping("/springdoc/test")
public void test(@RequestBody TestRequest request){
}
@Data
static class TestRequest {
/**
* aa
*/
@JsonProperty("b")
private String a;
}
}Expected behavior
The Javadoc descriptions for properties should be retained in the OpenAPI documentation even when using @JsonProperty to change property names.
Screenshots
If applicable, add screenshots to help explain the problem.
Additional context
Add any other context about the problem here.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request