Added ProviderOperations endpoint and fixed description warnings#2220
Added ProviderOperations endpoint and fixed description warnings#2220marstr merged 4 commits intoAzure:masterfrom
Conversation
|
Hi There, I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result: File: AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback Thanks for your co-operation. |
|
Hi There, I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result: File: AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback Thanks for your co-operation. |
| } | ||
| }, | ||
| "security": [ { "oauth2": [ "user_impersonation" ] } ], | ||
| "security": [ { "azure_auth": [ "user_impersonation" ] } ], |
There was a problem hiding this comment.
Taking a look at the Redis swagger, I believe that in addition to renaming the security line from oauth2 to azure_auth, one must define a "securityDefintions" clause.
More info here from the spec: https://swagger.io/specification/#securitySchemeObject
There was a problem hiding this comment.
yeah, i already have that in line 8717
There was a problem hiding this comment.
Excellent, thanks for the link. Sorry I didn't see it!
| "paths": { | ||
| "/providers/Microsoft.DevTestLab/operations": { | ||
| "get": { | ||
| "tags": [ "ProviderOperations" ], |
There was a problem hiding this comment.
In all of the other specs I'm looking at, the tag is just Operations not ProviderOperations.
There was a problem hiding this comment.
Operations are already used in the end point for polling long running operations. I think ProviderOperations makes it clear.
There was a problem hiding this comment.
@ravbhatnagar, do you have thoughts on the name of the Operations group? It sounds like we're sorta flexible here, which is fine with me. I just want to make sure that's true though.
There was a problem hiding this comment.
@marstr - Do you mean the operationId? or the tags value. The operationId should be consistent between teams and I am not sure how tags is used. So I dont have a recommendation on that.
There was a problem hiding this comment.
I think its used by the autorest tool to segregate the generated code
marstr
left a comment
There was a problem hiding this comment.
Looks good from my perspective, I'll approve one @ravbhatnagar or @simongdavies have approved.
| } | ||
| }, | ||
| "security": [ { "oauth2": [ "user_impersonation" ] } ], | ||
| "security": [ { "azure_auth": [ "user_impersonation" ] } ], |
There was a problem hiding this comment.
Excellent, thanks for the link. Sorry I didn't see it!
|
Looks good. |
This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.
PR information
api-versionin the path should match theapi-versionin the spec).Quality of Swagger