OpenAPITools / OpenAPITools/openapi-generator
[REQ][JAVA] Generate @JsonPropertyDescription from description
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
In the rising AI word it would be beneficial to have @JsonPropertyDescription in generated client model/classes.
Describe the solution you'd like
Generate @JsonPropertyDescription from description on generated models/classes
Describe alternatives you've considered
generating already available swagger annotations, but this require additional dependency
Additional contex
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The request targets Java generated client model/classes and asks for @JsonPropertyDescription from each model property's description. Start by tracing the Java model-generation templates or entry points and how property descriptions are handled; compare with the existing Swagger-annotation alternative. Done means generated Java models include the requested annotation from the OpenAPI description without requiring that alternative dependency.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100