Reference: auth-required | TypeSpec Azure
Problem
It is very helpful that we already is a couple of examples for each linter rule, however, the information provided in each linter rule still need to be improved to help service teams understand:
- Why the rule matters
- What impact it has on API design, ARM compliance, SDK generation, and client experience
- Whether the violation is a mandatory fix or just a recommendation
- How to fix the issue based on the service type (ARM vs Data Plane)
- Whether suppression should ever be considered
Proposed Improvement
-
Impact Information: whether it impacts SDK or Azure or data plane or mgmt. plane etc.
-
Severity Classification: Is it just a warning that could be suppressed or it is an item that people must fix.
-
Diagnostic Message: what the error message would look like for the linter, what is the detailed impact with this linter rule, what the recommendation fix would be, etc.
-
Suppression Guidance if needed.
Reference: auth-required | TypeSpec Azure
Problem
It is very helpful that we already is a couple of examples for each linter rule, however, the information provided in each linter rule still need to be improved to help service teams understand:
Proposed Improvement
Impact Information: whether it impacts SDK or Azure or data plane or mgmt. plane etc.
Severity Classification: Is it just a warning that could be suppressed or it is an item that people must fix.
Diagnostic Message: what the error message would look like for the linter, what is the detailed impact with this linter rule, what the recommendation fix would be, etc.
Suppression Guidance if needed.