Azure / Azure/openapi-diff

Removing `readOnly: true` on response-only property is flagged as error

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

描述

While migrating Key Vault specs from Swagger to TSP, we [removed](https://github.com/Azure/azure-rest-api-specs/pull/28708/commits/bde57be10ffbd04acc86fe2d441e4aae8a62bbbc) a `readOnly` designation for a property on a response-only type. This was [flagged as an error](https://dev.azure.com/azure-sdk/internal/_build/results?buildId=4481832&view=logs&j=98f87804-8e1f-5655-af02-e80aefa7aa97&t=65457206-7ab6-5966-2a2f-9ae3efa14a03&l=931-955) by the OpenAPI diff; per context in [this review thread](https://github.com/Azure/azure-rest-api-specs/pull/28708#discussion_r1917533739), this error doesn't seem to be correct.

贡献指南

打开贡献指南

调研方向

首先查看链接的 Key Vault 迁移提交、OpenAPI diff 构建日志以及引用的 pull request review 讨论串,以了解如何比较仅存在于响应中的属性。重现报告的错误,并确定移除 readOnly: true 后的预期结果;完成的标准是 diff 不再将这一有效更改标记为错误,同时仍能检测到真正的破坏性更改。

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

评估

技术栈
csharp, openapi
领域
cli, devtools
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
35/100

把新 issue 发到你的邮箱

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