incompatible api diff result when one of property in model becomes not required

オープン

#535 2023年6月22日に作成コメント 2 件リアクション 1 件担当者 0 名 GitHub で見る

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

Breaking/Non-Breaking classification

説明

if in new api version some property is not required anymore, new api is recognized as not compatible

old api schema definition:

"SomeDto": {
        "required": [
          "prop1",
          "prop2",
          "prop3"
        ], ...

new api schema definition:

"SomeDto": {
        "required": [
          "prop1"
        ], ...

まず、issue に示されている古いスキーマ定義と新しいスキーマ定義の比較を再現し、次に、必須プロパティの変更が非互換として分類される箇所を追跡します。プロパティがオプションになるケースを diff が正しく処理し、その例のスキーマを対象とするリグレッションテストが含まれていれば完了です。

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

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