[REQ] Parse OpenAPI 3.2 documents (query / additionalOperations / in: querystring) with the released swagger-parser via an adapter
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- java, openapi
調査の方向性
Start at CodegenConfigurator.toContext() and read the existing parser call and the Oas31RawSpecRecovery precedent. Check how MergedSpecBuilder consumes parsed specs, then verify parser behavior for a minimal OpenAPI 3.2 document rewritten to 3.1, including relative $refs. Done means the generate path preserves the named 3.2 members and provides a tested way for generation to access restored operations.
索引モデルが issue の本文から書いたものです。
説明
Is your feature request related to a problem? Please describe.
openapi-generator can't read OpenAPI 3.2 documents today. With the released swagger-parser (2.1.48), OpenAPIParser.readLocation returns no OpenAPI object for a minimal document with openapi: 3.2.0. It then tries the Swagger 2 converter and reports:
attribute paths.'/things'.query is unexpected
attribute paths.'/things'.additionalOperations is unexpected
attribute openapi is unexpected
attribute swagger is missing
in: querystring is not reported at all.
I opened the upstream PRs for 3.2 support: swagger-api/swagger-core#5326, swagger-api/swagger-parser#2401 and swagger-api/swagger-parser#2402. They are still open, and swagger-core 3.0.0 (released 2026-10-28) doesn't include them. I'm not aware of an announced release date. #24982 (codegen for query, additionalOperations and in: querystring) is blocked on them.
Describe the solution you'd like
An adapter in front of the parser call used by the generate workflow, i.e. CodegenConfigurator.toContext(), which the CLI and the Maven/Gradle plugins go through. This is also where the TODO for #844 ("custom spec loader implementations") sits.
-
Default: for 3.0/3.1 documents, call
readLocationexactly as today. -
3.2 documents (root
openapi: 3.2.x):- The adapter reads the raw text itself and rewrites it:
openapibecomes3.1.0;queryandadditionalOperationson path items move intox-oas32-*extensions;in: querystringbecomesin: query, with the original value kept inx-oas32-in. The 3.1 path rejectsquerystringas aninvalue.- Every other 3.2-only key in a fixed table also moves into
x-oas32-*, e.g.$self, tagparent/kind, responsesummary,itemSchema,oauth2MetadataUrl,deviceAuthorization. Otherwise the 3.1 path reports them as unexpected attributes, and generation fails under the defaultvalidateSpec. They are kept rather than silently dropped.
- It parses the result with
OpenAPIV3Parser.readContents(text, auth, options, inputSpec), so relative$refs still resolve against the original location. - It deserializes the moved
query/additionalOperationsmaps intoOperationobjects and keeps them onPathItemextensions under fixed keys. The releasedswagger-modelshas noPathItem.query/additionalOperationsand noSpecVersion.V32. A small accessor (e.g.Oas32.query(pathItem)) is the only thingDefaultGeneratorand #24982 would read. #24982 would switch to that accessor instead of the new model getters.
When swagger-core/swagger-parser ship 3.2 support, the rewrite and the accessor are the two places that change.
- The adapter reads the raw text itself and rewrites it:
There is precedent for re-reading the raw document and carrying facts in x- extensions: Oas31RawSpecRecovery (#24760).
With swagger-parser 2.1.48 (resolve=true), a minimal 3.2 document rewritten as in step 1 parsed as 3.1 with no messages. The moved members came back as raw extension values: maps on the path item, x-oas32-in on the parameter. Turning those maps into Operation objects and generating from them is not verified yet.
Scope and open points:
- The first scope is those three members, not full 3.2 support.
- The first PR would only wire the generate path and
MergedSpecBuilder. The other parse sites callOpenAPIParserdirectly:validatein CLI/Maven/Gradle/Mill, the Maven plugin's spec-hash andcollapsedSpechelpers, the online service, andOas31RawSpecRecovery. I'd make the adapter a reusable helper so they can switch to it later. $refs to external files that themselves use 3.2-only members would need the same rewrite.$refs inside restored operations don't go through the parser's resolver. This needs dedicated tests.- Generated clients that parse the spec at runtime (java okhttp-gson
dynamicOperations) aren't covered. They stay limited to their own pinned parser.
Describe alternatives you've considered
- Wait for the swagger-core/swagger-parser releases. Cleanest, but there's no date.
- Depend on a fork of the parser and models published under another groupId. It uses the same
io.swagger.v3packages, so it would clash with the official artifacts on users' classpaths unless excluded or shaded. It also means relying on an individually maintained artifact for the core parser. - Patch swagger-parser classes at runtime (bytecode instrumentation). Fragile across parser versions, and it adds deployment requirements for CLI, plugin and embedded use.
Additional context
Decisions I'd need before starting:
- Is rewriting a 3.2 document to 3.1 at the generate entry point acceptable?
- Are extension-held
Operations plus an accessor acceptable until swagger-core ships the model fields? - For other 3.2-only keys under
validateSpec, is "move tox-oas32-*and keep" the right policy, or should they produce a warning or error?
If this works for you, I'd open a PR with the adapter and tests first, then rebase #24982 onto it. If you'd rather wait for the upstream releases, I'll keep #24982 as a draft until then.
- 主要言語
- Java
- スター
- 26.9k
- フォーク
- 7.8k
- 平均マージ
- 2日 10時間
- マージ済み PR(30日)
- 180
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
OpenAPITools/openapi-generator のほかの issue
-
Issue: Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
OpenAPITools/openapi-generator#25643 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
OpenAPITools/openapi-generator#25640 ·
メンテナーはふだん 1 日以内に返信
-
[BUG][JAVA] Deprecated properties only get @Deprecated on the getter (base, feign, native, microprofile)対応中かも @Inf1mum が 2 日前に担当しました。 オープンIssue: Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
OpenAPITools/openapi-generator#25567 ·
メンテナーはふだん 1 日以内に返信
-
[BUG][KOTLIN-SERVER] typeInfoAnnotation.mustache uses As.PROPERTY → discriminator property serialized twice対応中かも @Inf1mum が 9 日前に担当しました。 オープンIssue: Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
OpenAPITools/openapi-generator#25524 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
[REQ][JAVA][resteasy] Support for Jackson 3 / useJackson3対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンEnhancement: Feature
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
OpenAPITools/openapi-generator#25364 ·
メンテナーはふだん 1 日以内に返信
OpenAPITools/openapi-generator の issue をすべて見る
似ている issue
-
bug emitter:client:csharp
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
microsoft/typespec#12572 · コメント 1 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
GCC 15.2: -Wcast-qual warning - cast discards const qualifier from pointer target type (H5trace.c)オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 73/100
メンテナーはふだん 1 日以内に返信
-
[Bug] RemotingHelper.connect swaps the socket send and receive buffer configuration対応中かも @amalsaidov が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
needs-area-label
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 2 日以内に返信
-
area/ai area/backend component/zeebe kind/task
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信