OpenAPITools / OpenAPITools/openapi-diff
No backward compatible changes in Schema are marked as Compatible
还没有人认领这个 Issue。
- 主要语言
- Java
- 星标
- 1.1k
- 派生
- 190
- PR 合并指标
- 30 天内没有已合并 PR
描述
Hello, Thanks alot for this great library. I am testing this library and found the following bugs when comparing Schemas,
Library version: 'org.openapitools.openapidiff:openapi-diff-core:2.1.0-beta.8'
- Removing an attribute from a Model is a non-backward compatible change, but It is marked as COMPATIBLE.
- Updating description of an attribute is a Metadata change but this is also marked as COMPATIBLE
After several tests, I deduced, The current version is able to detect any change in schema models, but all changes are marked as COMPATIBLE. I think the compatibility checks including metadata change checks are missing.
Please have a look and provide a roadmap when this feature can be fixed. Thanks alot for all the effort and excellent work.
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
使用 openapi-diff-core 2.1.0-beta.8 重现已报告的比较，重点关注 schema 属性移除和属性描述变更。跟踪 schema 兼容性检查；当被移除的模型属性被报告为不兼容，并且仅描述变更被归类为元数据变更而不是兼容时，即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- java
- 领域
- api
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100