Azure / Azure/openapi-diff

False positives for rule 1007 RemovedClientParameter when using typespec-autorest

オープン
#280 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
C#
スター
290
フォーク
50
平均マージ
5日 13時間
マージ済み PR(30日)
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 を短くまとめたダイジェスト。