Azure / Azure/openapi-diff

False positives for rule 1007 RemovedClientParameter when using typespec-autorest

Open
#280 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
290
Forks
50
Avg merge
5d 13h
Merged PRs (30d)
5

Description

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
```

Contributor guide

Open the contributing guide

Research direction

Start with docs/rules/1007.md and the linked TypeSpec Azure issue, then reproduce the reported RemovedClientParameter findings using vmware.json and the referenced pull request. Determine whether these are false positives and how suppression is intended to work; done means a verified rule correction or a documented working suppression, with regression coverage if an applicable test exists.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, openapi
Domain
api, cli, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.