Add linter rule to suggest the scope parameter #765
+388
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…zure/azure-openapi-validator into bdefoy/suggest-scope-parameter
This rule should remain separate as it is a warning, not an error
bdefoy
requested review from
rkmanda,
mikeharder,
weshaggard,
tejaswiMinnu and
AkhilaIlla
as code owners
mikeharder
reviewed
Jan 28, 2025
rkmanda
reviewed
Jan 29, 2025
| ## How to fix | ||
|
|
||
| Remove all explicitly-scoped paths that only vary in scope and create a path with the `scope` parameter. | ||
|
|
There was a problem hiding this comment.
This may not be a good idea from a customer viewpoint as it makes it less obvious as to what scopes are truly supported. Before we decide one way or the other, lets first check how TypeSpec generates the different API paths for this scenario and align the linter rules to work with that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a rule that helps disambiguate paths that share the same
/providerssuffix by suggesting the use of thescopeparameter.