-
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
added incident alerts and incident bookmarks APIs #10806
Conversation
You don't have permission to trigger SDK Automation. |
[Staging] Swagger Validation Report
️✔️ |
Thank you for your contribution moranraz! We will review the pull request and get back to you soon. |
@@ -2932,6 +2932,102 @@ | |||
} | |||
} | |||
}, | |||
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/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.
Why are these 2 new APIs POST calls instead of GETs?
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.
Alerts and Bookmarks are not a child resource of an incident (they can be independent resources, or nested under other resources as well). Therefore we couldn't create a GET endpoint nested under the incidents resource.
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 see. Please rename the post actions to "listAlerts" and "listBookmarks" and make sure to map the authorization action for these to /read in your manifest. See https://armwiki.azurewebsites.net/rp_onboarding/ResourceProviderRegistration.html#authorizationactionmappings-optional
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.
changed the names.
the authorization mapping is already done.
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 am referring to the POST action name (the terminal URI segment). It should be "/listAlerts", etc...
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.
Oh, my bad. Changing the operation ids back.
As for adding it to the URI segment, I'm not sure this is what we want. None of our other APIs have this format of "/listSomething". Please see for example the action with the operation id "Incidents_ListOfEntities". That one is also a POST action (for the same reason I mentioned above), and the format is incidents/{incidentId}/entities.
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.
POST calls are actions, they should be a verb. Using a "list" prefix also allows them to be called from template deployments (although that isn't very useful in this scenario).
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 understand. However this is a POST call for more of a technical reason, rather than a logical one. The API names were a PM requirement, so we can be aligned with the rest of our calls (just incidents/{incidentId}/entities I mentioned, which is also a POST call for the same reason).
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
Azure CLI Extension Generation - Release
|
Trenton 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
|
azure-sdk-for-go - Release
|
azure-sdk-for-python - 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-sdk-for-net - 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
|
…into fix_kv_python_readme * 'master' of https://github.com/Azure/azure-rest-api-specs: (364 commits) Update pull_request_assignment.yml (Azure#11026) [Ready For Review] a new version with changes on compute instance/vm sizes (Azure#10542) correct the description (Azure#11009) [Data plane][Azure Cognitive Search] Add encryptionKey property to indexer, datasource and skillset metadata (Azure#10839) Adding reseller Id (Azure#11013) Update Phone Number Administration Swagger to remove unnecessary parameters, and adjust API responses. (Azure#11010) update all swaggers to 2020-05-01 API version (Azure#10960) Changed the Instance Field Description to Support Primitive Data type (Azure#10995) Fix the acronym casing for ACSSMS (Azure#10988) Update pull_request_assignment.yml (Azure#10974) Add sdk_customization.md (Azure#10861) [Hub Generated] Review request for Microsoft.DataMigration to add version preview/2018-07-15-preview (Azure#10494) Make version int64 (Azure#10984) Microsoft.Security/iotDefenderSettings (2020-08-06-preview) (Azure#10810) added incident alerts and incident bookmarks APIs (Azure#10806) add publicNetworkAccess property to datafactory (Azure#10956) Fix CDN matchValues and selector fields to be optional (Azure#10950) [Microsoft.StorageSync] Introduce 2020-09-01 API version (Azure#10836) strings update (Azure#10969) Update QnAMaker.json - response code correction (Azure#10828) ...
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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.