Skip to content

[Monitor] Adding proper error response behavior to the Action Groups API. Fixing documentation typos in the Activity Log Alerts and Action Groups APIs. #1622

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.

Sign up for GitHub

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

Merged
sergey-shandar merged 12 commits into from
Sep 1, 2017
Merged

[Monitor] Adding proper error response behavior to the Action Groups API. Fixing documentation typos in the Activity Log Alerts and Action Groups APIs. #1622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
dae5cba
Catching up with missing commits (not moved to the new branch), fFixi…
gucalder Jul 27, 2017
8a339ef
Removing success response code from example for log profiles delete A…
gucalder Aug 3, 2017
764f130
Merge branch 'current' of https://github.com/Azure/azure-rest-api-spe…
gucalder Aug 3, 2017
d04983f
Fixing some warnings and one example
gucalder Aug 3, 2017
ca4db34
Fixing issues with the examples validation.
gucalder Aug 7, 2017
d596398
Merge branch 'current' of https://github.com/Azure/azure-rest-api-spe…
gucalder Aug 7, 2017
b1bda80
Fixing one example.
gucalder Aug 7, 2017
6c48a91
Adding tags and location in the proper place for two examples.
gucalder Aug 7, 2017
3449ce9
Fixing name change in the body parameter and the corresponding exampl…
gucalder Aug 8, 2017
c266d97
Merge branch 'current' of https://github.com/Azure/azure-rest-api-spe…
gucalder Aug 8, 2017
5ed235c
Merge branch 'current' of https://github.com/Azure/azure-rest-api-spe…
gucalder Aug 29, 2017
23b956b
[Monitor] Adding proper error response behavior to the Action Groups …
gucalder Aug 31, 2017
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
51 changes: 43 additions & 8 deletions specification/monitor/resource-manager/microsoft.insights/2017-04-01/actionGroups_API.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,10 @@
}
},
"default": {
"description": "An error occurred and the action group could not be created or updated."
"description": "An error occurred and the action group could not be created or updated.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
Expand Down Expand Up @@ -116,7 +119,10 @@
}
},
"default": {
"description": "An error occurred and the action group could not be retrieved. 404: The action group does not exist."
"description": "An error occurred and the action group could not be retrieved. 404: The action group does not exist.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
Expand Down Expand Up @@ -150,7 +156,10 @@
"description": "The action group does not exist. It may have already been deleted."
},
"default": {
"description": "An error occurred and the action group could not be deleted."
"description": "An error occurred and the action group could not be deleted.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
Expand Down Expand Up @@ -183,7 +192,10 @@
}
},
"default": {
"description": "An error occurred and the list of action groups could not be retrieved."
"description": "An error occurred and the list of action groups could not be retrieved.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
Expand Down Expand Up @@ -219,7 +231,10 @@
}
},
"default": {
"description": "An error occurred and the list of action groups could not be retrieved."
"description": "An error occurred and the list of action groups could not be retrieved.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
Expand Down Expand Up @@ -260,8 +275,14 @@
"200": {
"description": "The receiver was successfully enabled."
},
"409": {
"description": "The receiver is already enabled in the action group."
},
"default": {
"description": "An error occurred and the receiver could not be enabled. 409: The receiver is already enabled in the action group. 404: The action group was not found or no matching receiver was found in the action group."
"description": "An error occurred and the receiver could not be enabled, e.g.: 404: The action group was not found or no matching receiver was found in the action group.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
Expand Down Expand Up @@ -333,7 +354,7 @@
},
"nextLink": {
"type": "string",
"description": "Provides the link to retrive the next set of elements."
"description": "Provides the link to retrieve the next set of elements."
}
}
},
Expand All @@ -348,7 +369,7 @@
"enabled": {
"type": "boolean",
"default": true,
"description": "Indicates whether this action group is enabled. If an action group is not enabled, then none of its receviers will receive communications."
"description": "Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications."
},
"emailReceivers": {
"type": "array",
Expand Down Expand Up @@ -467,6 +488,20 @@
"required": [
"receiverName"
]
},
"ErrorResponse": {
"description": "Describes the format of Error response.",
"type": "object",
"properties": {
"code": {
"description": "Error code",
"type": "string"
},
"message": {
"description": "Error message indicating why the operation failed.",
"type": "string"
}
}
}
},
"parameters": {
Expand Down
6 changes: 3 additions & 3 deletions ...ication/monitor/resource-manager/microsoft.insights/2017-04-01/activityLogAlerts_API.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@
}
},
"x-ms-examples": {
"Path an activity log alert": {
"Patch an activity log alert": {
"$ref": "./examples/patchActivityLogAlert.json"
}
}
Expand Down Expand Up @@ -352,7 +352,7 @@
},
"nextLink": {
"type": "string",
"description": "Provides the link to retrive the next set of elements."
"description": "Provides the link to retrieve the next set of elements."
}
}
},
Expand All @@ -373,7 +373,7 @@
},
"condition": {
"$ref": "#/definitions/ActivityLogAlertAllOfCondition",
"description": "The conditon that will cause this alert to activate."
"description": "The condition that will cause this alert to activate."
},
"actions": {
"$ref": "#/definitions/ActivityLogAlertActionList",
Expand Down