OpenAPITools / OpenAPITools/openapi-diff

Wrong changelog generated when having objects with same field name

未关闭
#268 4 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Java
星标
1.1k
派生
190
PR 合并指标
30 天内没有已合并 PR

描述

Lets say that the old and the new OpenAPI schemas have classes Object1 and Object2, both of which have a field myField1 without changes in-between the openapi schemas. If Obejct1.myField1 has different description than Object2.myField1, that would be detected as a change and printed in the output diff file.

Also, can you add some kind of configuration that would prevent the library to print such non-breaking changes (i.e. changed description is not a breaking change) ?

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

使用包含 Object1.myField1 和 Object2.myField1 的旧版和新版 OpenAPI schema 重现比较,其中只有它们的描述不同。跟踪 changelog diff 生成的入口点,并验证字段为何会在对象之间匹配。完成标准是:未更改的字段不再产生错误变更,并且已定义用于抑制不破坏向后兼容性的描述变更的配置行为。

由索引模型根据 Issue 内容生成。

评估

技术栈
java, openapi
领域
api
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。