-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Hub Generated] Review request for Microsoft.AlertsManagement to add version stable/2019-03-01 #10389
[Hub Generated] Review request for Microsoft.AlertsManagement to add version stable/2019-03-01 #10389
Conversation
[Staging] Swagger Validation Report
❌ |
Rule | Message |
---|---|
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups' removed or restructured? Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L329:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}' removed or restructured? Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L400:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/changeState' removed or restructured? Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L446:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/history' removed or restructured? Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L491:5 |
️️✔️
LintDiff [Detail]
️✔️
Validation passes for LintDiff.
️️✔️
Avocado [Detail]
️✔️
Validation passes for Avocado.
Azure Pipelines successfully started running 1 pipeline(s). |
azure-sdk-for-js - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
azure-sdk-for-net - Release
|
azure-sdk-for-java - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
Azure CLI Extension Generation - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
Can one of the admins verify this patch? |
azure-sdk-for-python - Release
|
Trenton Generation - Release
|
azure-sdk-for-go - Release
|
azure-sdk-for-python-track2 - Release
No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured
|
Hi @xccc-msft , I know the changes are considered a breaking change, however these are bug fixes for a misalignment between the ARM Manifest and the Alerts Management swagger. |
@orieldar Could you please help update CODEOWNERS for AlertsManagement? |
Azure Pipelines successfully started running 1 pipeline(s). |
Sure, done. |
@orieldar Thanks. I put on the label of |
...nagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json
Show resolved
Hide resolved
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.
Azure Pipelines successfully started running 1 pipeline(s). |
Azure Pipelines successfully started running 1 pipeline(s). |
Azure Pipelines successfully started running 1 pipeline(s). |
…-01' of https://github.com/orieldar/azure-rest-api-specs into dev-alertsmanagement-Microsoft.AlertsManagement-2019-03-01
Azure Pipelines successfully started running 1 pipeline(s). |
Azure Pipelines successfully started running 1 pipeline(s). |
Azure Pipelines successfully started running 1 pipeline(s). |
Azure Pipelines successfully started running 1 pipeline(s). |
Azure Pipelines successfully started running 1 pipeline(s). |
all tests pass except breakingchange, need your approval @iscai-msft @assing @xccc-msft, can you please review? |
@orieldar We still need ARM review. I'm from SDK team. |
@@ -52,6 +52,42 @@ | |||
} | |||
} | |||
}, | |||
"/providers/Microsoft.AlertsManagement/alertsMetaData": { |
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.
The response defined in this spec does not conform to the RPC. This is a collection GET and should follow the "paging response body" schema here: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md#get-resource
"alertsMetaData": { | ||
"description": "alert meta data information.", | ||
"properties": { | ||
"properties": { |
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.
Each "alertMetadata" resource should look like a resource with a name, type, and ID. They should also have individual GETs if you are modeling them as a GETable resource. Basically, make the API and definitions look a lot more like /alerts
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.
@pilor this change is only documenting the current API that our RP exposes. Would it be OK to approve this change, and we'll open a bug to fix the API in the coming sprints?
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.
Any new api-versions for this API need to conform to the RPC. You won't be able to make changes here in the future without implementing that
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.
API somehow got released in november without API review... approving the current version to avoid breaking. Future versions need to incorporate fixes
@akning-ms Can you please check the context and help merge? Thanks. |
Just a check, can we know why smartGroups not exposed in manifest? if it is a mistake, can we fix it in manifest, instead of change swagger? |
@akning-ms the smartGroups resource is still in public preview, and as such should not be part of a stable version swagger. So this is intended |
…version stable/2019-03-01 (Azure#10389) * Removed SmartAlerts from 2019-03-01 API * Added alertsmanagement to CODEOWNERS * Add alertsMetaData to match ARM Manifest * Added identifer parameter * Added alertsMetaData example * Removed Smart Groups Examples * Fixed example version * Added MoniterServiceList Definiton * Fixed exccesive parantheses * Added alertsData operation to 2019-03-01-preview * Added monitorServiceList * Removed alertsMetaData example from 2019-03-01-preview * Removed 2019-03-01-preview changes * Removed 2019-03-01-preview changes * Removed alertsMetaData example from 2019-03-01-preview * Added alertsMetaData example from 2019-03-01 * Removed alertsMetaData example from 2019-03-01-preview * Added default response for alertsMetaData
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
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.
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.
Please follow the link to find more details on PR review process.