OpenAPITools / OpenAPITools/openapi-diff
False positive breaking change when making a required request body optional
未关闭
还没有人认领这个 Issue。
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 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先创建或找到一对 OpenAPI 规范,其中某个操作的请求体从必需变为可选,然后运行报告 breaking changes 的比较。跟踪该请求体变更的兼容性结果,并检查附近的测试。当该变更不再被报告为不兼容,同时其他请求体不兼容问题仍能被检测到时,即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- java, openapi
- 领域
- api, backend-api-design
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 38/100