OpenAPITools / OpenAPITools/openapi-diff
false positive for type if only the format is changed.
未关闭
还没有人认领这个 Issue。
- 主要语言
- Java
- 星标
- 1.1k
- 派生
- 190
- PR 合并指标
- 30 天内没有已合并 PR
描述
i changed the format of a string property.
e.g. when generated out of java and the propery is now mapped via Spring from a String to a UUID.
Perhaps it's correct to report a change. but the change is not on the type but on the format.
and therefore userUid (string -> string) does not help.
old
"ServicePageInteractionRequest":{
"type":"object",
"properties":{
"userUid":{
"type":"string"
},
...
}
}
new
"ServicePageInteractionRequest" : {
"type" : "object",
"properties" : {
"userUid" : {
"type" : "string",
"format" : "uuid",
"example" : "5412185d-2cf1-46d0-85d3-50bfc93b1122"
},
...
}
}
report:
Changed property type: userUid (string -> string)
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
未指定源文件或测试。首先跟踪发出“Changed property type”的比较和报告路径,然后复现提供的 String-to-UUID 格式更改。当仅格式更改不再产生误导性的 string-to-string 类型报告,并且有一个涵盖该示例的回归测试时,即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- java, openapi
- 领域
- api
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100