Comparing OpenAPI 3.0.1 to 3.1.0 does not work
メンテナーはふだん 5 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- docker, java, openapi
調査の方向性
Main.java の CLI エントリポイントと OpenApiCompare.java の仕様読み込みパスから調査を始め、特にスタックトレースに示されている呼び出しを確認します。3.0.1 と 3.1.0 の同一のドキュメントを使って Docker および brew のコマンドを再現し、それらの動作を比較します。これらのバージョン間で有効な比較が機能し、同一のドキュメントを互換性がないと報告したり、読み込みに失敗したりしなければ完了です。
索引モデルが issue の本文から書いたものです。
説明
When running a comparison between OpenAPI 3.0.1 and 3.1.0 via Docker, it looks like everything is reported as different.
Suppressing the details gives this:
$ docker run --rm -t -v .:/specs:ro openapitools/openapi-diff /specs/api-docs-301.json /specs/api-docs-310.json --state
incompatible
ℹ Please note that those spec files are identical, only the initial OpenAPI version differs:
"openapi": "3.0.1""openapi": "3.1.0"
Comparing two specs with OpenAPI 3.1.0 seems to work as desired. ✅
I used latest which appears to be 6 weeks old - cannot get the version from the tool itself 🤷
Running the same via openapi-diff installed from brew shows a different error:
$ openapi-diff api-docs-301.json api-docs-310.json
Unexpected exception. Reason: Cannot read new OpenAPI spec
java.lang.RuntimeException: Cannot read new OpenAPI spec
at org.openapitools.openapidiff.core.OpenApiCompare.notNull(OpenApiCompare.java:107)
at org.openapitools.openapidiff.core.OpenApiCompare.fromSpecifications(OpenApiCompare.java:102)
at org.openapitools.openapidiff.core.OpenApiCompare.fromLocations(OpenApiCompare.java:91)
at org.openapitools.openapidiff.cli.Main.main(Main.java:174)
But this also does not work with two OpenAPI 3.1.0 specs:
$ openapi-diff api-docs-310.json api-docs-310.json
Unexpected exception. Reason: Cannot read old OpenAPI spec
java.lang.RuntimeException: Cannot read old OpenAPI spec
Brew shows this to be version 2.0.1 - cannot get the version from the tool itself.
- 主要言語
- Java
- スター
- 1.1k
- フォーク
- 191
- 平均マージ
- 4日 23時間
- マージ済み PR(30日)
- 1
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
OpenAPITools/openapi-diff のほかの issue
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
OpenAPITools/openapi-diff#506 ·
メンテナーはふだん 5 日以内に返信
-
HtmlRender: Notes of Parameters shows always the new description対応中かも @Inf1mum が 6 日前に担当しました。 オープンgood first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
OpenAPITools/openapi-diff#364 ·
メンテナーはふだん 5 日以内に返信
-
Render capabilities
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
OpenAPITools/openapi-diff#959 ·
メンテナーはふだん 5 日以内に返信
-
Render capabilities
難易度 5/5 1週間以上 初心者へのやさしさ 18/100
OpenAPITools/openapi-diff#958 ·
メンテナーはふだん 5 日以内に返信
-
Render capabilities
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
OpenAPITools/openapi-diff#957 ·
メンテナーはふだん 5 日以内に返信
OpenAPITools/openapi-diff の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
jenkins-infra/plugin-modernizer-tool#2070 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Event search answers 500 when calendars, attendees or organizers holds a null element再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープンai-driven-qa bug Minor
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
linagora/twake-calendar-side-service#1615 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 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 日以内に返信