OpenAPITools / OpenAPITools/openapi-generator
[REQ] [jaxrs-spec] Support for case-insensitive string enums for jaxrs-spec
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.
Given the following enum spec:
enum:
- HDD
- SSD
- NVME
type: string
The jaxrs-spec generator will generate an enum that does strict == comparisons, so if the specified API returns NVMe instead of NVME, the response will fail validation because "NVMe" != "NVME".
Describe the solution you'd like
The Java generator supports a useEnumCaseInsensitive option; when that option is enabled, the generator will use case-insensitive equality checks for string enums. Copying that feature into the jaxrs-spec generator would enable generator users to opt in to case-insensitive comparisons for string enums.
Additional context
Relates to issue 16634
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 comparing the jaxrs-spec generator's string-enum handling with the Java generator's useEnumCaseInsensitive option, and review related issue 16634 for context. Confirm the generated enum behavior for values such as NVMe versus NVME and add coverage showing that the opt-in behavior works without changing the default strict comparison.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- backend-api-design, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100