Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

False positives for rule 1007 RemovedClientParameter when using typespec-autorest #280

Open
cataggar opened this issue Nov 2, 2023 · 3 comments

Comments

@cataggar
Copy link
Member

cataggar commented Nov 2, 2023

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. 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:

suppressions:
  - code: RemovedClientParameter
    reason: typespec-autorest puts the parameters in each operation
    from: vmware.json
directive:
  - suppress: RemovedClientParameter
    reason: typespec-autorest puts the parameters in each operation
    from: vmware.json
@cataggar
Copy link
Member Author

cataggar commented Nov 3, 2023

It sounds like these are not suppressible https://aka.ms/azsdk/pr-suppressions . Please update openapi-diff to not report these false positives.

@cataggar
Copy link
Member Author

cataggar commented Nov 3, 2023

From @johanste:

I just did a spot-check on the client parameter breaking change rule, and it seem to be ignoring the x-ms-parameter-location directive. In other words, it complaining about client parameters gone missing because the parameters as not in the parameters section should not complain if said parameter was explicitly marked as not being a client parameter.

@mikekistler
Copy link
Member

Also reported here (nearly a year ago): Azure/azure-sdk-tools#5025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants