No difference reported for required property changed to optional
未關閉
還沒有人認領這個 Issue。
bug
- 主要語言
- C#
- 星號
- 290
- 分支
- 50
- 平均合併
- 5 天 13 小時
- 30 天內合併 PR
- 5
描述
Openapi-diff does not report a required property that was changed to optional -- removed from the schema "required" array. Changing a required property to optional in an output schema could cause breaking changes if a client relies on a property always being present in a response (because it was marked "required") and the property is then omitted from some responses in the new version.
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從命令列工具的 OpenAPI schema 比較開始,追蹤 schema 的 "required" 陣列如何處理。在兩份規格中重現回報的從必要到選用的變化,然後驗證工具會將該變更回報為 breaking。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- csharp
- 領域
- api, cli
- Issue 類型
- 缺陷
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100