OpenAPITools / OpenAPITools/openapi-generator

[BUG] maven-plugin - `ignoreAnyOfInEnum` works with embedded enum but not with ref

Open
#21,105 5 comments 0 reactions 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

Config & version

<plugin>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-generator-maven-plugin</artifactId>
  <version>7.12.0</version>
  <executions>
      <execution>
          <goals>
              <goal>generate</goal>
          </goals>
          <configuration>              
              <generatorName>java</generatorName>
              <library>restclient</library>              
              ...
              <configOptions>                  
                  <ignoreAnyOfInEnum>true</ignoreAnyOfInEnum>                 
              </configOptions>
          </configuration>
      </execution>
  </executions>
</plugin>

The processing of the ignoreAnyOfInEnum param behaves differently depending on how the schema is modeled.

Problem description

The following DOES work:

"type": {
  "anyOf": [
    {
      "type": "string",
      "enum": [
        "A",
        "B",
        "C"              
      ],
      "description": "Predefined types"
    },
    {
      "type": "string",
      "pattern": "^/other.*",
      "description": "Non-standard types"
    }
  ]
}

But this one does NOT (which expresses the exact same thing):

"type": {
  "anyOf": [
    {
      "$ref": "#/components/schemas/TypeStandard"
    },
    {
      "$ref": "#/components/schemas/TypeOther"
    }
  ]
},
"TypeStandard": {
  "type": "string",
  "enum": [
    "A",
    "B",
    "C"
  ],
  "description": "Predefined types"
},
"TypeOther": {
  "type": "string",
  "pattern": "^/other.*",
  "description": "Non-standard types"
},   

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 Java generator and the Maven plugin's handling of ignoreAnyOfInEnum. Reproduce the difference using the inline anyOf and referenced-schema examples in the issue, then compare how each schema is processed. Done means referenced enum schemas behave like embedded enums when the option is true.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
Issue type
Bug
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.