You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
While descriptions from JavaDoc normally work, if you rename json property, it looses JavaDoc description.
I presume somewhere inside it does not keep original property name and if the name gets change by JsonProperty it loses mapping with JavaDoc.
To Reproduce
Steps to reproduce the behavior:
Create Webflux API server.
Add controller with POST request using model class with a property.
Enable JavaDoc, generate Swagger - JavaDoc is used as description.
Add JsonProperty with different name over the property - description becomes empty.
What version of spring-boot you are using?
3.1.1
What modules and versions of springdoc-openapi are you using?
What is the actual and the expected result using OpenAPI Description (yml or json)?
Property description taken from JavaDoc becomes empty if JsonProperty is used.
"properties": {
"task_id": {
"type": "string"
}
}
Expected property description from JavaDoc regardless of using JsonProperty attribute.
Describe the bug
While descriptions from JavaDoc normally work, if you rename json property, it looses JavaDoc description.
I presume somewhere inside it does not keep original property name and if the name gets change by JsonProperty it loses mapping with JavaDoc.
To Reproduce
Steps to reproduce the behavior:
Create Webflux API server.
Add controller with POST request using model class with a property.
Enable JavaDoc, generate Swagger - JavaDoc is used as
description
.Add
JsonProperty
with different name over the property -description
becomes empty.3.1.1
Property description taken from JavaDoc becomes empty if JsonProperty is used.
Expected property description from JavaDoc regardless of using JsonProperty attribute.
Expected behavior
The property should change its name with JsonProperty but description should stay as per JavaDoc.
The text was updated successfully, but these errors were encountered: