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.

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

Jump to bottom

Added new receivers to action group document. #2077

Merged
merged 19 commits into from
Jan 9, 2018
Merged

Added new receivers to action group document. #2077

Changes from 3 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
59af5b9
Added new receivers to action group document.
Dec 1, 2017
8cd8b0c
fixed few comments.
Dec 4, 2017
283f3ad
Corrected the file syntactically using openapi-linter
Dec 4, 2017
68748c5
Add required patch operation for which it is flagging this documentation
Dec 9, 2017
8e429b0
Fixed some liter format validation issues, added patch example
Dec 11, 2017
d00501b
Fixed couple for validation errors
Dec 14, 2017
0ef0531
Fixed new validation error for runbook receiver
Dec 14, 2017
3ffbce8
fixed the description field for ITSM Ticket configuration field.
Dec 15, 2017
519230d
Added new receivers to action group document.
Dec 1, 2017
4782243
fixed few comments.
Dec 4, 2017
dbd23df
Corrected the file syntactically using openapi-linter
Dec 4, 2017
6563da7
Add required patch operation for which it is flagging this documentation
Dec 9, 2017
db04cc2
Fixed some liter format validation issues, added patch example
Dec 11, 2017
dcc811e
Fixed couple for validation errors
Dec 14, 2017
e9e4271
Fixed new validation error for runbook receiver
Dec 14, 2017
eada97a
fixed the description field for ITSM Ticket configuration field.
Dec 15, 2017
c002bd9
merge from remote
Jan 3, 2018
83964be
Added example file for patch operation to new directory called stable.
Jan 3, 2018
7a323fa
Merge branch 'master' into documentation
Jan 9, 2018
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
63 changes: 63 additions & 0 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 @@ -391,6 +391,20 @@
"$ref": "#/definitions/WebhookReceiver"
},
"description": "The list of webhook receivers that are part of this action group."
},
"ItsmReceivers": {
"type": "array",
"items": {
"$ref": "#/definitions/ItsmReceiver"
},
"description": "The list of ITSM receivers that are part of this action group."
},
"AzureAppPushReceivers": {
"type": "array",
"items": {
"$ref": "#/definitions/AzureAppPushReceiver"
},
"description": "The list of AzureAppPush receivers that are part of this action group."
}
},
"required": [
Expand Down Expand Up @@ -464,6 +478,55 @@
"serviceUri"
]
},
"ItsmReceiver": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because these are not required properties, I don't believe this is a breaking change.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding new properties - required or optional is considered a breaking change. This could result in clients unitentionally overriding the properties on the server. Imagine a resource got created with this new property. Then the GET on the resource happened from a client which did not understand this property and so ignored it. Now if the PUT happens from the same client using the resource that was obtained via GET, the value of this property on the server will be overridden.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So it is advisable to increment the api-version for this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already released for this API version and is almost like a baseline now. In future we are planning to support patch operation for individual receiver types. We will change the version then.

"description": "An Itsm receiver.",
"properties": {
"name": {
"type": "string",
"description": "The name of the Itsm receiver. Names must be unique across all receivers within an action group."
},
"workspaceId": {
"type": "string",
"description": "OMS LA instance identifier."
},
"connectionId": {
"type": "string",
"description": "Unique identification of ITSM connection among multiple defined in above workspace."
},
"ticketConfiguration": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this property? Is this xml?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is JSON configuration string.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, the description is fixed in new iteration.

"type": "string",
"description": "XML blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well."
},
"region": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make this an enum

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean region field? It is already released as string field for better readability.

"type": "string",
"description": "Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'"
}
},
"required": [
"name",
"workspaceId",
"connectionId",
"ticketConfiguration",
"region"
]
},
"AzureAppPushReceiver": {
"description": "The Azure mobile App push notification receiver.",
"properties": {
"name": {
"type": "string",
"description": "The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group."
},
"emailAddress": {
"type": "string",
"description": "The email address registered for the Azure mobile app."
}
},
"required": [
"name",
"emailAddress"
]
},
"ReceiverStatus": {
"type": "string",
"enum": [
Expand Down