Skip to content

Changed swagger to fit the new return value from actions controller #7171

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
erich-wang merged 3 commits into from
Sep 20, 2019
Merged

Changed swagger to fit the new return value from actions controller #7171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae5e59e
Changed swagger and examples
YuvalShilo-Microsoft Sep 10, 2019
f004d5a
changed comment
YuvalShilo-Microsoft Sep 11, 2019
406eff2
changed description
YuvalShilo-Microsoft Sep 11, 2019
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
50 changes: 40 additions & 10 deletions ...ource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Action"
"$ref": "#/definitions/ActionResponse"
}
},
"default": {
Expand Down Expand Up @@ -398,13 +398,13 @@
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Action"
"$ref": "#/definitions/ActionResponse"
}
},
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/Action"
"$ref": "#/definitions/ActionResponse"
}
},
"default": {
Expand Down Expand Up @@ -2103,7 +2103,7 @@
},
"type": "object"
},
"Action": {
"ActionRequest": {
"allOf": [
{
"$ref": "#/definitions/Resource"
Expand All @@ -2116,18 +2116,48 @@
"type": "string"
},
"properties": {
"$ref": "#/definitions/ActionProperties",
"description": "Action properties",
"$ref": "#/definitions/ActionRequestProperties",
"description": "Action properties for put request",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"ActionProperties": {
"ActionRequestProperties": {
"description": "Action property bag.",
"properties": {
"triggerUri": {
"description": "The uri for the action to trigger.",
"description": "Logic App Callback URL for this specific workflow.",
"type": "string"
}
},
"type": "object"
},
"ActionResponse": {
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"description": "Action for alert rule.",
"properties": {
"etag": {
"description": "Etag of the action.",
"type": "string"
},
"properties": {
"$ref": "#/definitions/ActionResponseProperties",
"description": "Action properties for get request",
"x-ms-client-flatten": true
}
},
"type": "object"
},
"ActionResponseProperties": {
"description": "Action property bag.",
"properties": {
"workflowId": {
Copy link
Copy Markdown
Contributor

@KrisBash KrisBash Sep 12, 2019

Choose a reason for hiding this comment

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

this looks like a breaking change. It should go in a new API version

Copy link
Copy Markdown
Contributor Author

@YuvalShilo-Microsoft YuvalShilo-Microsoft Sep 15, 2019

Choose a reason for hiding this comment

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

Our product is still in preview, that's why we are doing these changes now..
we don't think there should be a new API version.

"description": "The name of the logic app's workflow.",
"type": "string"
}
},
Expand All @@ -2144,7 +2174,7 @@
"value": {
"description": "Array of actions.",
"items": {
"$ref": "#/definitions/Action"
"$ref": "#/definitions/ActionResponse"
},
"type": "array"
}
Expand Down Expand Up @@ -5470,7 +5500,7 @@
"name": "action",
"required": true,
"schema": {
"$ref": "#/definitions/Action"
"$ref": "#/definitions/ActionRequest"
},
"x-ms-parameter-location": "method"
},
Expand Down
4 changes: 2 additions & 2 deletions ...SecurityInsights/preview/2019-01-01-preview/examples/actions/CreateActionOfAlertRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"type": "Microsoft.SecurityInsights/alertRules/actions",
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"properties": {
"triggerUri": "https://prod-31.northcentralus.logic.azure.com:443/workflows/cd3765391efd48549fd7681ded1d48d7/triggers/manual/paths/invoke?api-version=2016-10-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=signature"
"workflowId": "cd3765391efd48549fd7681ded1d48d7"
}
}
},
Expand All @@ -36,7 +36,7 @@
"type": "Microsoft.SecurityInsights/alertRules/actions",
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"properties": {
"triggerUri": "https://prod-31.northcentralus.logic.azure.com:443/workflows/cd3765391efd48549fd7681ded1d48d7/triggers/manual/paths/invoke?api-version=2016-10-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=signature"
"workflowId": "cd3765391efd48549fd7681ded1d48d7"
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion ...ecurityInsights/preview/2019-01-01-preview/examples/actions/GetActionOfAlertRuleById.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"type": "Microsoft.SecurityInsights/alertRules/actions",
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"properties": {
"triggerUri": "https://prod-31.northcentralus.logic.azure.com:443/workflows/cd3765391efd48549fd7681ded1d48d7/triggers/manual/paths/invoke?api-version=2016-10-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=signature"
"workflowId": "cd3765391efd48549fd7681ded1d48d7"
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion ...ecurityInsights/preview/2019-01-01-preview/examples/actions/GetAllActionsByAlertRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"type": "Microsoft.SecurityInsights/alertRules/actions",
"etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
"properties": {
"triggerUri": "https://prod-31.northcentralus.logic.azure.com:443/workflows/cd3765391efd48549fd7681ded1d48d7/triggers/manual/paths/invoke?api-version=2016-10-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=signature"
"workflowId": "cd3765391efd48549fd7681ded1d48d7"
}
}
]
Expand Down