OpenAPITools / OpenAPITools/openapi-generator

[BUG][Java] Enums with non english language use underscore _ as an identifier

Open
#15,024 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

The following enum:

                properties:
                  id:
                    type: integer
                    format: int32
                    example: 1
                  name:
                    type: string
                    enum:
                      - هجري
                      - ميلادي
                    maxLength: 7
                    example: هجري

results in:

  public enum NameEnum {
    _("هجري"),
    
    _("ميلادي");

    private String value;

Which in invalid for two reason, 1) underscore is not a valid identifier, 2) The invalid name is repeated.

Solution used by another generator:

  public enum NameEnum {
    _1("هجري"),
    
    _2("ميلادي");

    private String value;

openapi-generator version

6.4

OpenAPI declaration file content or url
Generation Details

spring

Steps to reproduce
Related issues/PRs
Suggest a fix

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

Reproduce the issue with the supplied OpenAPI enum and the spring generator, then inspect the generated NameEnum output. Confirm that non-English enum values produce valid, unique Java identifiers, and rerun generation to verify the result.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.