Skip to content
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

Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add alertsMetaData to match ARM Manifest
  • Loading branch information
orieldar committed Aug 11, 2020
commit 074f80a9d0a3c4b402e1cbc955f78b87e5d05968
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,36 @@
}
}
},
"/providers/Microsoft.AlertsManagement/alertsMetaData": {
Copy link
Contributor

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

"get": {
"operationId": "Alerts_MetaData",
"description": "List alerts meta data information based on value of identifier parameter.",
"parameters": [
{
"$ref": "#/parameters/api-version"
},
{
"$ref": "#/parameters/identifier"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "OK. Successfully listed alert meta data.",
"schema": {
"$ref": "#/definitions/alertsMetaData"
}
}
},
"x-ms-examples": {
"MonService": {
"$ref": "./examples/AlertsMetaData_MonitorService.json"
}
}
}
},
"/{scope}/providers/Microsoft.AlertsManagement/alerts": {
"get": {
"operationId": "Alerts_GetAll",
Expand Down Expand Up @@ -1190,6 +1220,34 @@
}
}
},
"alertsMetaData": {
"description": "alert meta data information.",
"properties": {
"properties": {
Copy link
Contributor

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

Copy link
Member

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?

Copy link
Contributor

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

"$ref": "#/definitions/alertsMetaDataProperties"
}
}
},
"alertsMetaDataProperties": {
"description": "alert meta data property bag",
"discriminator": "metadataIdentifier",
"required": [
"metadataIdentifier"
],
"properties": {
"metadataIdentifier": {
"type": "string",
"description": "Identification of the information to be retrieved by API call",
"enum": [
"MonitorServiceList"
],
"x-ms-enum": {
"name": "metadataIdentifier",
"modelAsString": true
}
}
}
},
"smartGroupsList": {
"description": "List the alerts.",
"properties": {
Expand Down