You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Timestamp when the incident type was created.
46419
46422
format: date-time
@@ -46455,6 +46458,53 @@ components:
46455
46458
required:
46456
46459
- name
46457
46460
type: object
46461
+
IncidentTypeConfiguration:
46462
+
description: >-
46463
+
The incident-type-scoped behavior settings. All fields are optional on update. Any field omitted from a PATCH request keeps its current value. This object is read-only on the incident type resource itself and is only mutated through the update (PATCH) endpoint.
46464
+
properties:
46465
+
allow_incident_deletion:
46466
+
default: false
46467
+
description: Whether incidents of this type can be deleted.
46468
+
example: false
46469
+
type: boolean
46470
+
allow_workflows:
46471
+
default: true
46472
+
description: Whether automation workflows can be triggered for incidents of this type.
46473
+
example: true
46474
+
type: boolean
46475
+
create_message:
46476
+
description: An optional message shown to users when they declare an incident of this type.
46477
+
example: "Create an incident here"
46478
+
type: string
46479
+
disable_out_of_the_box_postmortem_template:
46480
+
default: false
46481
+
description: Whether the out-of-the-box postmortem template is disabled for incidents of this type.
46482
+
example: false
46483
+
type: boolean
46484
+
editable_timestamps:
46485
+
default: false
46486
+
description: Whether responders can edit incident timestamps for incidents of this type.
46487
+
example: false
46488
+
type: boolean
46489
+
private_incidents:
46490
+
default: false
46491
+
description: >-
46492
+
Whether responders can create private incidents of this type. This is an opt-in setting, distinct from `private_incidents_by_default`, which controls whether incidents are created private automatically.
46493
+
example: false
46494
+
type: boolean
46495
+
private_incidents_by_default:
46496
+
default: false
46497
+
description: Whether incidents of this type are created as private by default.
description: Whether incidents of this type are treated as test incidents.
46505
+
example: true
46506
+
type: boolean
46507
+
type: object
46458
46508
IncidentTypeCreateData:
46459
46509
description: Incident type data for a create request.
46460
46510
properties:
@@ -46549,6 +46599,18 @@ components:
46549
46599
required:
46550
46600
- data
46551
46601
type: object
46602
+
IncidentTypeSlugSource:
46603
+
default: default
46604
+
description: >-
46605
+
When set to `servicenow`, incidents will display the ServiceNow record ID instead of the public ID. If no ServiceNow integration exists, the public ID will be displayed.
46606
+
enum:
46607
+
- default
46608
+
- servicenow
46609
+
example: default
46610
+
type: string
46611
+
x-enum-varnames:
46612
+
- DEFAULT
46613
+
- SERVICENOW
46552
46614
IncidentTypeType:
46553
46615
default: incident_types
46554
46616
description: Incident type resource type.
@@ -46561,6 +46623,8 @@ components:
46561
46623
IncidentTypeUpdateAttributes:
46562
46624
description: Incident type's attributes for updates.
Copy file name to clipboardExpand all lines: features/v2/incidents.feature
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -166,7 +166,7 @@ Feature: Incidents
166
166
Scenario: Create an incident type returns "Bad Request" response
167
167
Given operation "CreateIncidentType" enabled
168
168
And new "CreateIncidentType" request
169
-
And body with value {"data": {"attributes": {"description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", "is_default": false, "name": "Security Incident"}, "type": "incident_types"}}
169
+
And body with value {"data": {"attributes": {"configuration": {"allow_incident_deletion": false, "allow_workflows": true, "create_message": "Create an incident here", "disable_out_of_the_box_postmortem_template": false, "editable_timestamps": false, "private_incidents": false, "private_incidents_by_default": false, "slug_source": "default", "test_incidents": true}, "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", "is_default": false, "name": "Security Incident"}, "type": "incident_types"}}
170
170
When the request is sent
171
171
Then the response status is 400 Bad Request
172
172
@@ -182,7 +182,7 @@ Feature: Incidents
182
182
Scenario: Create an incident type returns "Not Found" response
183
183
Given operation "CreateIncidentType" enabled
184
184
And new "CreateIncidentType" request
185
-
And body with value {"data": {"attributes": {"description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", "is_default": false, "name": "Security Incident"}, "type": "incident_types"}}
185
+
And body with value {"data": {"attributes": {"configuration": {"allow_incident_deletion": false, "allow_workflows": true, "create_message": "Create an incident here", "disable_out_of_the_box_postmortem_template": false, "editable_timestamps": false, "private_incidents": false, "private_incidents_by_default": false, "slug_source": "default", "test_incidents": true}, "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data.", "is_default": false, "name": "Security Incident"}, "type": "incident_types"}}
186
186
When the request is sent
187
187
Then the response status is 404 Not Found
188
188
@@ -1298,7 +1298,7 @@ Feature: Incidents
1298
1298
Given operation "UpdateIncidentType" enabled
1299
1299
And new "UpdateIncidentType" request
1300
1300
And request contains "incident_type_id" parameter from "REPLACE.ME"
1301
-
And body with value {"data": {"attributes": {"description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", "is_default": false, "name": "Security Incident"}, "id": "00000000-0000-0000-0000-000000000000", "type": "incident_types"}}
1301
+
And body with value {"data": {"attributes": {"configuration": {"allow_incident_deletion": false, "allow_workflows": true, "create_message": "Create an incident here", "disable_out_of_the_box_postmortem_template": false, "editable_timestamps": false, "private_incidents": false, "private_incidents_by_default": false, "slug_source": "default", "test_incidents": true}, "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", "is_default": false, "name": "Security Incident"}, "id": "00000000-0000-0000-0000-000000000000", "type": "incident_types"}}
1302
1302
When the request is sent
1303
1303
Then the response status is 400 Bad Request
1304
1304
@@ -1307,7 +1307,7 @@ Feature: Incidents
1307
1307
Given operation "UpdateIncidentType" enabled
1308
1308
And new "UpdateIncidentType" request
1309
1309
And request contains "incident_type_id" parameter from "REPLACE.ME"
1310
-
And body with value {"data": {"attributes": {"description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", "is_default": false, "name": "Security Incident"}, "id": "00000000-0000-0000-0000-000000000000", "type": "incident_types"}}
1310
+
And body with value {"data": {"attributes": {"configuration": {"allow_incident_deletion": false, "allow_workflows": true, "create_message": "Create an incident here", "disable_out_of_the_box_postmortem_template": false, "editable_timestamps": false, "private_incidents": false, "private_incidents_by_default": false, "slug_source": "default", "test_incidents": true}, "description": "Any incidents that harm (or have the potential to) the confidentiality, integrity, or availability of our data. Note: This will notify the security team.", "is_default": false, "name": "Security Incident"}, "id": "00000000-0000-0000-0000-000000000000", "type": "incident_types"}}
* The incident-type-scoped behavior settings. All fields are optional on update. Any field omitted from a PATCH request keeps its current value. This object is read-only on the incident type resource itself and is only mutated through the update (PATCH) endpoint.
16
+
*/
17
+
"configuration"?: IncidentTypeConfiguration;
13
18
/**
14
19
* Timestamp when the incident type was created.
15
20
*/
@@ -59,6 +64,10 @@ export class IncidentTypeAttributes {
* The incident-type-scoped behavior settings. All fields are optional on update. Any field omitted from a PATCH request keeps its current value. This object is read-only on the incident type resource itself and is only mutated through the update (PATCH) endpoint.
12
+
*/
13
+
exportclassIncidentTypeConfiguration{
14
+
/**
15
+
* Whether incidents of this type can be deleted.
16
+
*/
17
+
"allowIncidentDeletion"?: boolean;
18
+
/**
19
+
* Whether automation workflows can be triggered for incidents of this type.
20
+
*/
21
+
"allowWorkflows"?: boolean;
22
+
/**
23
+
* An optional message shown to users when they declare an incident of this type.
24
+
*/
25
+
"createMessage"?: string;
26
+
/**
27
+
* Whether the out-of-the-box postmortem template is disabled for incidents of this type.
28
+
*/
29
+
"disableOutOfTheBoxPostmortemTemplate"?: boolean;
30
+
/**
31
+
* Whether responders can edit incident timestamps for incidents of this type.
32
+
*/
33
+
"editableTimestamps"?: boolean;
34
+
/**
35
+
* Whether responders can create private incidents of this type. This is an opt-in setting, distinct from `private_incidents_by_default`, which controls whether incidents are created private automatically.
36
+
*/
37
+
"privateIncidents"?: boolean;
38
+
/**
39
+
* Whether incidents of this type are created as private by default.
40
+
*/
41
+
"privateIncidentsByDefault"?: boolean;
42
+
/**
43
+
* When set to `servicenow`, incidents will display the ServiceNow record ID instead of the public ID. If no ServiceNow integration exists, the public ID will be displayed.
44
+
*/
45
+
"slugSource"?: IncidentTypeSlugSource;
46
+
/**
47
+
* Whether incidents of this type are treated as test incidents.
48
+
*/
49
+
"testIncidents"?: boolean;
50
+
51
+
/**
52
+
* A container for additional, undeclared properties.
53
+
* This is a holder for any undeclared properties as specified with
54
+
* the 'additionalProperties' keyword in the OAS document.
* When set to `servicenow`, incidents will display the ServiceNow record ID instead of the public ID. If no ServiceNow integration exists, the public ID will be displayed.
* The incident-type-scoped behavior settings. All fields are optional on update. Any field omitted from a PATCH request keeps its current value. This object is read-only on the incident type resource itself and is only mutated through the update (PATCH) endpoint.
16
+
*/
17
+
"configuration"?: IncidentTypeConfiguration;
13
18
/**
14
19
* Timestamp when the incident type was created.
15
20
*/
@@ -59,6 +64,10 @@ export class IncidentTypeUpdateAttributes {
0 commit comments