OpenAPITools / OpenAPITools/openapi-generator

[REQ][Go] Support case-insensitive string enums

Open
#16,634 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
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 Go client 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 Go generator would enable generator users to opt in to case-insensitive comparisons for string enums.

Describe alternatives you've considered

Things I've tried:

  • First I tried adding NVMe to the list of enum items, but that didn't work because the generated Go enums use constants where the name is the uppercased enum value, so both NVMe and NVME end up with the name MYENUM_NVME, leading to an error MYENUM_NVME redeclared in this block.
  • Then I tried using custom templates to implement x-enum-as-string support. That's feasible with custom templates, but the extent of the template changes convinced me that that support would be better implemented in the generator than as a template-only change.

Additional context

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Go generator's string-enum generation and compare it with the Java generator's useEnumCaseInsensitive option. Review the generated Go enum behavior and any custom-template approach mentioned in the issue; done means an opt-in setting produces case-insensitive comparisons for Go string enums without enum constant name conflicts.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, java, openapi
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.