[OpenAPI 3.1] Phase 3: wire the converter in

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

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

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
java, openapi
領域
api, tooling

調査の方向性

Start from the plan in #942 and the converter landed in Phase 2, then trace every caller of OpenApiDiff.compare() and fromSpecifications to see where copies must be made before conversion. The 3.0-shape reads and the temporary both-shapes branches from Phase 2 need removing, and the renderers must be updated so a multi-type prints as string | null. Run the 3.0-to-3.1 cross-version tests, including the specs from #755 and #858, add a test proving fromSpecifications leaves its arguments untouched, and draft the 3.0.0 migration notes covering result schemas, the --json shape and removed APIs.

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

説明

OpenAPI 3.1.0 Support

Part of the OpenAPI 3.1 plan: #942 (Stage 1, Phase 3)

Goal

Every spec is converted to 3.1 before comparing. Results contain the 3.1 form.

Scope
  • Call the converter in OpenApiDiff.compare(); fromSpecifications works on copies
  • Remove the 3.0-shape reads and the temporary both-shapes code from Phase 2
  • Renderers read 3.1 fields; multiple types print as string | null
  • Write the 3.0.0 migration notes: result schemas are 3.1 objects, --json shape, removed or changed APIs
Done when
  • 3.0→3.1 cross-version tests pass, including the specs from #755 and #858
  • fromSpecifications doesn't modify the objects passed in (test)
  • Migration notes drafted
主要言語
Java
スター
1.1k
フォーク
191
平均マージ
4日 23時間
マージ済み PR(30日)
1

環境構築

はじめの一歩

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

OpenAPITools/openapi-diff のほかの issue

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

似ている issue

Java の issue をもっと見る

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

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