OpenAPITools / OpenAPITools/openapi-generator
[REQ] Support for OpenAPI 3.0-style documented enums
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.
With OpenAPI 3.0 there a pattern that allows to document integer-based enums without having to rely on x-enum-varnames and x-enum-descriptions: https://github.com/OAI/OpenAPI-Specification/issues/681#issuecomment-438503247
Describe the solution you'd like
It would be great to have this pattern supported. Currently, it doesn't generate anything.
Describe alternatives you've considered
We can keep using the old vendor extensions for now. But it would be great to support the new pattern as well.
Additional context
None that I can see.
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
Start by reading the OpenAPI 3.0 enum pattern described in the linked specification discussion and trace how openapi-generator currently handles documented integer enums and the legacy vendor extensions. Done means the pattern generates the expected enum documentation without requiring x-enum-varnames or x-enum-descriptions.
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
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100