Skip to content

Add delete incident comment API #11297

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
leniatgh merged 4 commits into from
Oct 28, 2020
Merged

Add delete incident comment API #11297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cec0208
Add delete incident comment
roherzbe Oct 20, 2020
aa1290e
Fix for Prettier
roherzbe Oct 20, 2020
fda2996
Fix Prettier 2
roherzbe Oct 20, 2020
1416e5e
Merge branch 'master' of https://github.com/roherzbe/azure-rest-api-s…
roherzbe Oct 20, 2020
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
67 changes: 64 additions & 3 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 @@ -3150,14 +3150,14 @@
},
"put": {
"x-ms-examples": {
"Creates an incident comment.": {
"Creates or updates an incident comment.": {
"$ref": "./examples/incidents/comments/CreateIncidentComment.json"
}
},
"tags": [
"IncidentComments"
],
"description": "Creates the incident comment.",
"description": "Creates or updates the incident comment.",
"operationId": "IncidentComments_CreateComment",
"parameters": [
{
Expand Down Expand Up @@ -3186,6 +3186,12 @@
}
],
"responses": {
"200": {
Copy link
Contributor

@pilor pilor Oct 20, 2020

Choose a reason for hiding this comment

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

Are these swagger bugfixes to bring swagger in-line with how the API has always behaved? If not, these should go into a new api-version as the existing preview version is almost 2 years old.

Copy link
Contributor Author

@roherzbe roherzbe Oct 21, 2020

Choose a reason for hiding this comment

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

Yes, this is a bug fix. It exists in production for more then half a year and has no costumer impact (not breaking any scenario). We are aware that in the stable version this kind of change will require a new version.

"description": "OK",
"schema": {
"$ref": "#/definitions/IncidentComment"
}
},
"201": {
"description": "Created",
"schema": {
Expand All @@ -3199,6 +3205,55 @@
}
}
}
},
"delete": {
"x-ms-examples": {
"Delete the incident comment.": {
"$ref": "./examples/incidents/comments/DeleteIncidentComment.json"
}
},
"tags": [
"IncidentComments"
],
"description": "Delete the incident comment.",
"operationId": "IncidentComments_DeleteComment",
"parameters": [
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/SubscriptionId"
},
{
"$ref": "#/parameters/ResourceGroupName"
},
{
"$ref": "#/parameters/OperationalInsightsResourceProvider"
},
{
"$ref": "#/parameters/WorkspaceName"
},
{
"$ref": "#/parameters/IncidentId"
},
{
"$ref": "#/parameters/IncidentCommentId"
}
],
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "No Content"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/entities": {
Expand Down Expand Up @@ -6939,7 +6994,7 @@
"IncidentComment": {
"allOf": [
{
"$ref": "#/definitions/Resource"
"$ref": "#/definitions/ResourceWithEtag"
}
],
"description": "Represents an incident comment",
Expand Down Expand Up @@ -6981,6 +7036,12 @@
"readOnly": true,
"type": "string"
},
"lastModifiedTimeUtc": {
"description": "The time the comment was updated",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"message": {
"description": "The comment message",
"type": "string"
Expand Down
21 changes: 21 additions & 0 deletions ...nsights/preview/2019-01-01-preview/examples/incidents/comments/CreateIncidentComment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,35 @@
}
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"type": "Microsoft.SecurityInsights/incidents/comments",
"etag": "190057d0-0000-0d00-0000-5c6f5adb0000",
"properties": {
"message": "Some message",
"createdTimeUtc": "2019-01-01T13:15:30Z",
"lastModifiedTimeUtc": "2019-01-03T11:10:30Z",
"author": {
"objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
"email": "john.doe@contoso.com",
"userPrincipalName": "john@contoso.com",
"name": "john doe"
}
}
}
},
"201": {
"body": {
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"type": "Microsoft.SecurityInsights/incidents/comments",
"etag": "190057d0-0000-0d00-0000-5c622adb0000",
"properties": {
"message": "Some message",
"createdTimeUtc": "2019-01-01T13:15:30Z",
"lastModifiedTimeUtc": "2019-01-01T13:15:30Z",
"author": {
"objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
"email": "john.doe@contoso.com",
Expand Down
15 changes: 15 additions & 0 deletions ...nsights/preview/2019-01-01-preview/examples/incidents/comments/DeleteIncidentComment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"parameters": {
"api-version": "2019-01-01-preview",
"subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
"resourceGroupName": "myRg",
"workspaceName": "myWorkspace",
"operationalInsightsResourceProvider": "Microsoft.OperationalInsights",
"incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
"incidentCommentId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014"
},
"responses": {
"200": {},
"204": {}
}
}
2 changes: 2 additions & 0 deletions ...sights/preview/2019-01-01-preview/examples/incidents/comments/GetAllIncidentComments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"type": "Microsoft.SecurityInsights/incidents/comments",
"etag": "190057d0-0000-0d00-0000-5c6f5adb0000",
"properties": {
"message": "Some message",
"createdTimeUtc": "2019-01-01T13:15:30Z",
"lastModifiedTimeUtc": "2019-01-03T11:10:30Z",
"author": {
"objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
"email": "john.doe@contoso.com",
Expand Down
2 changes: 2 additions & 0 deletions ...sights/preview/2019-01-01-preview/examples/incidents/comments/GetIncidentCommentById.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@
"id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
"type": "Microsoft.SecurityInsights/incidents/comments",
"etag": "190057d0-0000-0d00-0000-5c6f5adb0000",
"properties": {
"message": "Some message",
"createdTimeUtc": "2019-01-01T13:15:30Z",
"lastModifiedTimeUtc": "2019-01-03T11:10:30Z",
"author": {
"objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
"email": "john.doe@contoso.com",
Expand Down