OpenAPITools / OpenAPITools/openapi-diff
False positive breaking change when making a required request body optional
オープン
まだ誰も着手していません。
Breaking/Non-Breaking classification
- 主要言語
- Java
- スター
- 1.1k
- フォーク
- 190
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
If the request body of an operation changes from required to optional, the change will be detected as an incompatible change.
I argue that this is a false positive, because existing clients are still able to communicate as before.
If this issue is accepted, I would be happy to contribute a PR to fix it :)
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、ある操作のリクエストボディが必須から任意に変わる OpenAPI 仕様のペアを作成または見つけ、breaking changes を報告する比較を実行します。そのリクエストボディの変更について互換性の結果を追跡し、近くにあるテストを確認します。他のリクエストボディの非互換性は引き続き検出される一方で、その変更が非互換として報告されなくなれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java, openapi
- 領域
- api, backend-api-design
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100