OpenAPITools / OpenAPITools/openapi-diff
Adding a new optional property to the request/response body is considered backward incompatible.
オープン
まだ誰も着手していません。
Breaking/Non-Breaking classification
- 主要言語
- Java
- スター
- 1.1k
- フォーク
- 190
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Hi,
Why adding a new optional property (with default value) is considered to be an incompatible change?
- V1 client sends a request without a new field - then the default value will be used by the V2 server - [OK]
- V1 client receives the response from the V2 server with a new field - it will simply be ignored by the V1 client - [OK]
I really do not see why the diff tool reports it as an incompatible change?
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、2つの最小限の OpenAPI 仕様を使って互換性レポートを再現します。1つは元のリクエスト/レスポンスボディを含むもの、もう1つはデフォルト値を持つオプショナルなプロパティを追加したものです。diff ツールがそのリクエストとレスポンスの変更をどのように分類するかを追跡し、その結果を issue に記載された想定される後方互換性の動作と照合して確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java
- 領域
- api
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100