Azure / Azure/openapi-diff

False positives for rule 1007 RemovedClientParameter when using typespec-autorest

未關閉
#280 3 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
C#
星號
290
分支
50
平均合併
5 天 13 小時
30 天內合併 PR
5

描述

Hi, I'm working on https://github.com/Azure/azure-rest-api-specs-pr/pull/15631 and there are a bunch of breaking changes reported for [rule 1007](https://github.com/Azure/openapi-diff/blob/master/docs/rules/1007.md). According to https://github.com/Azure/typespec-azure/issues/3795 , these are false positives. Are these false positives? Can the rule be updated to eliminate these false positives?

How can I suppress these false positives? I've tried a few options without luck:

``` yaml
suppressions:
- code: RemovedClientParameter
reason: typespec-autorest puts the parameters in each operation
from: vmware.json
```

``` yaml
directive:
- suppress: RemovedClientParameter
reason: typespec-autorest puts the parameters in each operation
from: vmware.json
```

貢獻指南

開啟貢獻指南

研究方向

從 docs/rules/1007.md 和連結的 TypeSpec Azure issue 開始,接著使用 vmware.json 和所參照的 pull request 重現回報的 RemovedClientParameter 發現。判斷這些是否屬於 false positives,以及 suppression 預期應如何運作;完成表示已驗證規則修正,或已記錄可正常運作的 suppression,並在存在適用測試時提供回歸覆蓋。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
csharp, openapi
領域
api, cli, tooling
Issue 類型
缺陷
難度
4/5
預估耗時
3-5 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
28/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。