[BUG][JAVA] Bug generating attribute with multiple types in OAS 3.1
メンテナーはふだん 1 日以内に返信
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 35/100
調査の方向性
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 の本文から書いたものです。
説明
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
- Save the spec above as
multi-type.yamlnext to apom.xmlcontaining the plugin executions above. - Run
mvn generate-sources. - Look at the normalizer errors in the log.
- Open
target/spring/.../model/Company.javaortarget/java/.../model/Company.java: thetradingNamesfield isAnyOfstring<String>andimport org.example.model.AnyOfstring;is present, but noAnyOfstring.javais generated. Compiling the generated sources fails withcannot 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
typearray contains more than one non-null type, fall back to an any-type schema (generated asObject); 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
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
OpenAPITools/openapi-generator のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
OpenAPITools/openapi-generator#25768 ·
メンテナーはふだん 1 日以内に返信
-
Enhancement: Feature
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
OpenAPITools/openapi-generator#25753 ·
メンテナーはふだん 1 日以内に返信
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodError対応中かも @Inf1mum が 3 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
OpenAPITools/openapi-generator#25724 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an Array対応中かも @Inf1mum が 3 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
OpenAPITools/openapi-generator#25723 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twice対応中かも @Inf1mum が 2 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
OpenAPITools/openapi-generator#25719 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
OpenAPITools/openapi-generator の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
eclipse-tradista/tradista#371 ·
メンテナーはふだん 1 日以内に返信
-
critical
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
mars-sim/mars-sim#2199 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
primefaces/primefaces#15568 ·
メンテナーはふだん 1 日以内に返信
-
崩溃日志只按 CRLF 分行オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
PCL-Community/PCL-CE#3872 ·
メンテナーはふだん 1 日以内に返信