Update scheduledQueryRule_API.json To use the right error contract #11898
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
Fixed Error contract to fit the real structure
Swagger Generation Artifacts
|
|
Hi @adklinge, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
This was referenced Dec 2, 2020
Removed readonly properties from example parameters
Added property "displayName" to the structure
|
@kairu-ms - The breaking changes errors are all due to the change in the schema of the error message. |
|
@kairu-ms - as for the failures in the Generation Artifacts, I am not sure how my PR changes effected file: It does not seem related. Could you please take a look and advice how to resolve it ? |
@adklinge It does have a breaking change. Because your error response body has been changed from {"code": "errorCode", "message": "errorMessage"}to {"error": {"code": "errorCode", "message": "errorMessage"}} |
Hi @kairu-ms, the server has always returned : It is just the swagger document that was not aligned and showed : We are not changing anything in the service response, therefor there will be no customer breaking change. |
Hi @adklinge. It is a breaking change. You should follow Breaking Change Policy. |
Added missing enum values to ConditionalOperator property
adklinge
commented
Dec 7, 2020
| "GreaterThan", | ||
| "LessThan", | ||
| "Equal" | ||
| ], | ||
| "default" : "GreaterThanOrEqual", |
There was a problem hiding this comment.
This is a fix to s360 violation :
https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=D6E5FC34-0663-472E-952E-8B9F5C0C8D17
When ConditionalOperator is not specified by PUT, the service populates it with the default value of 'GreaterThanOrEqual'.
Therefor, this is not a breaking (we do not change the service current behavior) change but an alignment of the swagger.
adklinge
commented
Dec 7, 2020
| @@ -536,6 +549,7 @@ | |||
| "Consecutive", | |||
| "Total" | |||
| ], | |||
| "default" : "Consecutive", | |||
There was a problem hiding this comment.
This is a fix to s360 violation :
https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=D6E5FC34-0663-472E-952E-8B9F5C0C8D17
When "MetricTriggerType" is not specified by PUT, the service populates it with the default value of 'Consecutive'.
Therefor, this is not a breaking (we do not change the service current behavior) change but an alignment of the swagger.
adklinge
commented
Dec 7, 2020
| @@ -369,6 +373,11 @@ | |||
| "format": "duration", | |||
| "description": "The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size)." | |||
| }, | |||
| "OverrideQueryTimeRange": { | |||
There was a problem hiding this comment.
This is a fix to s360 violation :
https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=2EAB7F16-67CA-44F1-8877-39B8404F881F
adklinge
commented
Dec 7, 2020
...r/resource-manager/Microsoft.Insights/preview/2020-05-01-preview/scheduledQueryRule_API.json
Show resolved
Hide resolved
adklinge
commented
Dec 7, 2020
| @@ -405,6 +414,16 @@ | |||
| "properties" | |||
| ], | |||
| "properties": { | |||
| "kind" :{ | |||
There was a problem hiding this comment.
This is a fix to s360 violation :
https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=C09C7410-CA54-4450-96BF-BF46F64F2190
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
@adklinge , the model validation failures are false alarm that are caused by duplicated model definition of |
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
This was referenced Jan 26, 2021
25 tasks
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
…zure#11898) * Update scheduledQueryRule_API.json Fixed Error contract to fit the real structure * Update createOrUpdateScheduledQueryRules.json Removed readonly properties from example parameters * Update scheduledQueryRule_API.json Added property "displayName" to the structure * Fix to item ; https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=A596EA9C-C8E9-4A72-90FE-4689DFCBA3F6 Fix to item ; https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=A596EA9C-C8E9-4A72-90FE-4689DFCBA3F6 * added display name to the new API version * Fixed descriptions * Added OverrideQueryTimeRange to Swagger on new API version * returned enabled property back to bool * Update scheduledQueryRule_API.json Added missing enum values to ConditionalOperator property * Update scheduledQueryRule_API.json Aligned RP name to pascal format * revert lindent correvction to avoid breaking chnage * run prettier and fixed SubscriptionIdParameter * revert subscripton id to the former description * aligned diagnosticSettings with master * removed locaiton from example * returned location to example * supress false alaram OBJECT_ADDITIONAL_PROPERTIES error * fix suppression * fix merge conflict * removed where clause
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.
Fixed Error contract to fit the real structure
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.