Exclude GET verb from LroExtension rule validation #616
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "changes": [ | ||
| { | ||
| "packageName": "@microsoft.azure/openapi-validator-rulesets", | ||
| "comment": "Update RPC-GET-V1-01(GetResponseCodes) to allow GET with 202 response code if the GET represents the location header polling url. Update RPC-Post-V1-09(LroExtension) to exclude GET from x-ms-long-running-operation presence validation", | ||
| "type": "patch" | ||
| } | ||
| ], | ||
| "packageName": "@microsoft.azure/openapi-validator-rulesets" | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| # GetResponseCodes | ||
|
|
||
| ## Category | ||
|
|
||
| ARM Error | ||
|
|
||
| ## Applies to | ||
|
|
||
| ARM OpenAPI(swagger) specs | ||
|
|
||
| ## Related ARM Guideline Code | ||
|
|
||
| - RPC-Get-V1-01 | ||
|
|
||
| ## Description | ||
|
|
||
| The get operation should only return 200, also it should not be a long running operation. | ||
| In addition, it can return 202 only if it has location header defined (i.e, if it is a polling action). | ||
|
|
||
| ## How to fix the violation | ||
|
|
||
|
There was a problem hiding this comment. include good and bad examples #Closed |
||
| Remove all the other response codes except 200 and 202 with "Location" header defined | ||
| i.e, remove response codes 201, 202(if no "Location" header defined), 203, 204. | ||
|
|
||
| ## Good Examples | ||
|
|
||
| ```json | ||
| ... | ||
| "/providers/Microsoft.Music/songs/{songName}" { | ||
| "get" { | ||
| "responses": { | ||
| "200": { | ||
| "description": "Successful completion of the asynchronous operation", | ||
| "schema": { | ||
| "$ref": "#/definitions/SongName" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ... | ||
| ``` | ||
|
|
||
| ```json | ||
| ... | ||
| "/providers/Microsoft.Music/songOperations/{operationId}" { | ||
| "get" { | ||
| "responses": { | ||
| "200": { | ||
| "description": "Successful completion of the asynchronous operation", | ||
| "schema": { | ||
| "$ref": "#/definitions/SongName" | ||
| } | ||
| }, | ||
| "202": { | ||
| "description": "Accepted", | ||
| "headers": { | ||
| "Location": { | ||
| "description": "The URL where the status of the asynchronous operation can be checked.", | ||
| "type": "string" | ||
| }, | ||
| }, | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ... | ||
| ``` | ||
|
|
||
| ## Bad Examples | ||
|
|
||
| ```json | ||
| ... | ||
| "/providers/Microsoft.Music/songOperations/{operationId}" { | ||
| "get" { | ||
| "responses": { | ||
| "200": { | ||
| "description": "Successful completion of the asynchronous operation", | ||
| "schema": { | ||
| "$ref": "#/definitions/SongName" | ||
| } | ||
| }, | ||
| "201": { | ||
| "description": "Created", | ||
| }, | ||
| "203": { | ||
| "description": "Non authoritative", | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ... | ||
| ``` | ||
|
|
||
| ```json | ||
| ... | ||
| "/providers/Microsoft.Music/songOperations/{operationId}" { | ||
| "get" { | ||
| "responses": { | ||
| "202": { | ||
| "description": "Accepted", | ||
| "headers": { | ||
| "Location": { | ||
| "description": "The URL where the status of the asynchronous operation can be checked.", | ||
| "type": "string" | ||
| }, | ||
| }, | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ... | ||
| ``` | ||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#Closed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didnt add
"if the GET represents the location header polling url" cause that isnt being checked in this rule