Azure / Azure/openapi-diff

we should report breaking change for x-ms-discriminator-value change

未关闭
#350 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
C#
星标
290
派生
50
平均合并
5 天 13 小时
30 天内合并 PR
5

描述

See https://github.com/Azure/azure-rest-api-specs/pull/32483#discussion_r1948548308
As you can see the definition for [x-ms-discriminator-value](https://github.com/Azure/autorest/tree/main/docs/extensions#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.

贡献指南

打开贡献指南

调研方向

从链接的讨论和 x-ms-discriminator-value 扩展定义开始。跟踪工具如何对 OpenAPI 规范之间的 discriminator 变更进行分类。完成的标准是:对该值的变更(包括在模型名称之前为隐式值时添加显式值)会被报告为 API 层的 breaking changes。

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

评估

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

把新 issue 发到你的邮箱

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