we should report breaking change for x-ms-discriminator-value change
还没有人认领这个 Issue。
评估
调研方向
从链接的讨论和 x-ms-discriminator-value 扩展定义开始。跟踪工具如何对 OpenAPI 规范之间的 discriminator 变更进行分类。完成的标准是:对该值的变更(包括在模型名称之前为隐式值时添加显式值)会被报告为 API 层的 breaking changes。
由索引模型根据 Issue 内容生成。
描述
See https://github.com/Azure/azure-rest-api-specs/pull/32483#discussion_r1948548308
As you can see the definition for x-ms-discriminator-value it indicates the discriminator property's value on the wire layer, therefore, any changes related to x-ms-discriminator-value should be considered as an api layer breaking change.
A side note, the default x-ms-discriminator-value for any models that contains discriminator property is the model name itself. Which means if there's a model named A that doesn't have x-ms-discriminator-value before, and they newly added x-ms-discriminator-value and set it as B, it's also a breaking change.
- 主要语言
- C#
- 星标
- 290
- 派生
- 50
- 平均合并
- 2 天 21 小时
- 30 天内合并 PR
- 10
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
Azure/openapi-diff 的其他 Issue
-
Azure/openapi-diff#482 · 已指派 1 人 ·
-
Azure/openapi-diff#479 · 2 条评论 · 已指派 1 人 ·
-
Azure/openapi-diff#456 · 已指派 1 人 ·
-
难度 4/5 3-5 天 新手友好度 35/100
Azure/openapi-diff#445 ·
-
Azure/openapi-diff#371 · 7 条评论 · 已指派 1 人 ·
查看 Azure/openapi-diff 的全部 Issue
相似的 Issue
-
bug
难度 1/5 1 小时以内 新手友好度 90/100
-
Type: enhancement
难度 2/5 1-3 小时 新手友好度 65/100
apache/arrow-adbc#4809 ·
-
type/automation type/tech-debt
难度 2/5 1-3 小时 新手友好度 70/100
-
难度 2/5 1-3 小时 新手友好度 65/100
microsoft/vscode-azurefunctions#5197 · 1 条评论 ·
-
难度 1/5 1 小时以内 新手友好度 85/100
microsoft/microsoft-ui-reactor#1274 ·