[BUG][JAVA] Bug generating attribute with multiple types in OAS 3.1

Ouverte
#25,756 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@Inf1mum y travaille déjà.

Depuis le 19/11/2026.

  • #25761 par @Inf1mum — ouverte

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
35/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
java, openapi, yaml
Domaine
tooling

Piste de recherche

Start in OpenAPINormalizer where the log line about multiple types is emitted, and trace how the 3.1 type array reaches the composed-schema naming that produces AnyOfstring. Reproduce with the spec in the issue via the Java or Spring generator, then inspect generated Company.java and confirm it compiles. A linked pull request #25761 is already open, so check that before starting; done means multi-type properties map to a generated type or Object without dangling imports.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Issue: Bug
Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator?
  • 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

In an OpenAPI 3.1 spec, a property declared with multiple non-null types (type: [array, string], i.e. "a list of strings or a single string") is generated as AnyOfstring<String>. No AnyOfstring class is generated, so the output does not compile:

import org.example.model.AnyOfstring;   // class does not exist
...
private AnyOfstring<String> tradingNames = new ArrayList<>();

During generation the normalizer logs:

[ERROR] Type array not yet supported in openapi-normalizer to process OpenAPI 3.1 spec with multiple types.
[ERROR] Please report the issue via https://github.com/OpenAPITools/openapi-generator/issues/new/.

Expected: compilable code. Since the property can be either a JSON array or a string, a reasonable mapping would be Object (any type), as is done for schemas without a type. An alternative would be a proper anyOf wrapper that is actually generated.

Actual: a reference to a non-existent generic type AnyOfstring<String>, initialized with new ArrayList<>().

The issue shows up with a real vendor spec (a published OpenAPI 3.1 API description we cannot modify), where fields like this are common. A related case with the same root cause: type: [object, array] logs Type object not yet supported in openapi-normalizer ... and is generated as Map<String, Object>. That compiles, but deserialization fails at runtime when the payload is an array.

openapi-generator version

7.27.0 (latest release).

OpenAPI declaration file content or url
openapi: 3.1.0
info:
  title: Multi-type property repro
  version: 1.0.0
paths:
  /companies/{id}:
    get:
      operationId: getCompany
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
components:
  schemas:
    Company:
      type: object
      properties:
        name:
          type: string
        tradingNames:
          description: A list for most countries, a single string for some.
          type:
            - array
            - string
          items:
            type: string
Generation Details

Maven plugin (org.openapitools:openapi-generator-maven-plugin:7.27.0), spec validation enabled (it passes), default normalizer settings:

<execution>
  <id>spring</id>
  <goals><goal>generate</goal></goals>
  <configuration>
    <inputSpec>${project.basedir}/multi-type.yaml</inputSpec>
    <generatorName>spring</generatorName>
    <library>spring-http-interface</library>
    <output>${project.build.directory}/spring</output>
    <modelPackage>org.example.model</modelPackage>
    <apiPackage>org.example.api</apiPackage>
    <configOptions><interfaceOnly>true</interfaceOnly></configOptions>
  </configuration>
</execution>
<execution>
  <id>java</id>
  <goals><goal>generate</goal></goals>
  <configuration>
    <inputSpec>${project.basedir}/multi-type.yaml</inputSpec>
    <generatorName>java</generatorName>
    <library>native</library>
    <output>${project.build.directory}/java</output>
    <modelPackage>org.example.model</modelPackage>
    <apiPackage>org.example.api</apiPackage>
  </configuration>
</execution>
Steps to reproduce
  1. Save the spec above as multi-type.yaml next to a pom.xml containing the plugin executions above.
  2. Run mvn generate-sources.
  3. Look at the normalizer errors in the log.
  4. Open target/spring/.../model/Company.java or target/java/.../model/Company.java: the tradingNames field is AnyOfstring<String> and import org.example.model.AnyOfstring; is present, but no AnyOfstring.java is generated. Compiling the generated sources fails with cannot find symbol: class AnyOfstring.
Related issues/PRs

No exact duplicate found.

Suggest a fix

In OpenAPINormalizer, the code path that logs Type ... not yet supported in openapi-normalizer to process OpenAPI 3.1 spec with multiple types leaves the schema as is, and later the composed-name logic produces AnyOf<type> without generating the class. Possible fixes:

  • when a 3.1 type array contains more than one non-null type, fall back to an any-type schema (generated as Object); or
  • convert it to an equivalent anyOf ([{type: array, items: ...}, {type: string}]) and go through the regular composed-schema handling.

Either way, the generator should never reference a model class it does not generate.

Langage dominant
Java
Étoiles
26.9k
Forks
7.8k
Merge moyen
2 j 23 min
PR mergées (30 j)
177

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de OpenAPITools/openapi-generator

Toutes les issues de OpenAPITools/openapi-generator

Issues similaires

Plus d'issues Java

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.