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

オープン
#25,756 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@Inf1mum がすでに取り組んでいます。

2026年11月19日 から。

  • #25761 @Inf1mum による — オープン

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
java, openapi, yaml
領域
tooling

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Java
スター
26.9k
フォーク
7.8k
平均マージ
2日 23分
マージ済み PR(30日)
177

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OpenAPITools/openapi-generator のほかの issue

OpenAPITools/openapi-generator の issue をすべて見る

似ている issue

Java の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。