Added new rule LroAzureAsyncOperationHeader #749
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
tejaswiMinnu
requested review from
rkmanda,
mikeharder,
weshaggard,
bdefoy and
AkhilaIlla
as code owners
bdefoy
reviewed
Oct 15, 2024
|
|
||
| ## Output Message | ||
|
|
||
| A 202 response should include an Azure-AsyncOperation response header. |
There was a problem hiding this comment.
Suggested change
| A 202 response should include an Azure-AsyncOperation response header. | |
| A 202 response must include an Azure-AsyncOperation response header. |
rkmanda
reviewed
Oct 16, 2024
| message: "{{description}}", | ||
| severity: "error", | ||
| formats: [oas2], | ||
| given: "$.paths[*][*].responses[?(@property == '202')]", |
There was a problem hiding this comment.
s[?(@Property == '202')
This rule is actually for all long running operations. Not just for the 202 status code. Sorry I should have clarified this earlier.
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.
LroAzureAsyncOperationHeader rule checks "Azure-AsyncOperation" header must be added for all async operations that response status code 202
WorkItem