Skip to content

Commit ef287da

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add Incident Notification Rules Public Spec (#2825)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 8cd7203 commit ef287da

File tree

58 files changed

+3493
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+3493
-1
lines changed

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 555 additions & 1 deletion
Large diffs are not rendered by default.

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4337,6 +4337,13 @@ datadog\_api\_client.v2.model.create\_data\_deletion\_response\_body module
43374337
:members:
43384338
:show-inheritance:
43394339

4340+
datadog\_api\_client.v2.model.create\_incident\_notification\_rule\_request module
4341+
----------------------------------------------------------------------------------
4342+
4343+
.. automodule:: datadog_api_client.v2.model.create_incident_notification_rule_request
4344+
:members:
4345+
:show-inheritance:
4346+
43404347
datadog\_api\_client.v2.model.create\_incident\_notification\_template\_request module
43414348
--------------------------------------------------------------------------------------
43424349

@@ -8516,6 +8523,118 @@ datadog\_api\_client.v2.model.incident\_notification\_handle module
85168523
:members:
85178524
:show-inheritance:
85188525

8526+
datadog\_api\_client.v2.model.incident\_notification\_rule module
8527+
-----------------------------------------------------------------
8528+
8529+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule
8530+
:members:
8531+
:show-inheritance:
8532+
8533+
datadog\_api\_client.v2.model.incident\_notification\_rule\_array module
8534+
------------------------------------------------------------------------
8535+
8536+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_array
8537+
:members:
8538+
:show-inheritance:
8539+
8540+
datadog\_api\_client.v2.model.incident\_notification\_rule\_array\_meta module
8541+
------------------------------------------------------------------------------
8542+
8543+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_array_meta
8544+
:members:
8545+
:show-inheritance:
8546+
8547+
datadog\_api\_client.v2.model.incident\_notification\_rule\_array\_meta\_page module
8548+
------------------------------------------------------------------------------------
8549+
8550+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_array_meta_page
8551+
:members:
8552+
:show-inheritance:
8553+
8554+
datadog\_api\_client.v2.model.incident\_notification\_rule\_attributes module
8555+
-----------------------------------------------------------------------------
8556+
8557+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_attributes
8558+
:members:
8559+
:show-inheritance:
8560+
8561+
datadog\_api\_client.v2.model.incident\_notification\_rule\_attributes\_visibility module
8562+
-----------------------------------------------------------------------------------------
8563+
8564+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_attributes_visibility
8565+
:members:
8566+
:show-inheritance:
8567+
8568+
datadog\_api\_client.v2.model.incident\_notification\_rule\_conditions\_items module
8569+
------------------------------------------------------------------------------------
8570+
8571+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_conditions_items
8572+
:members:
8573+
:show-inheritance:
8574+
8575+
datadog\_api\_client.v2.model.incident\_notification\_rule\_create\_attributes module
8576+
-------------------------------------------------------------------------------------
8577+
8578+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_create_attributes
8579+
:members:
8580+
:show-inheritance:
8581+
8582+
datadog\_api\_client.v2.model.incident\_notification\_rule\_create\_attributes\_visibility module
8583+
-------------------------------------------------------------------------------------------------
8584+
8585+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_create_attributes_visibility
8586+
:members:
8587+
:show-inheritance:
8588+
8589+
datadog\_api\_client.v2.model.incident\_notification\_rule\_create\_data module
8590+
-------------------------------------------------------------------------------
8591+
8592+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_create_data
8593+
:members:
8594+
:show-inheritance:
8595+
8596+
datadog\_api\_client.v2.model.incident\_notification\_rule\_create\_data\_relationships module
8597+
----------------------------------------------------------------------------------------------
8598+
8599+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_create_data_relationships
8600+
:members:
8601+
:show-inheritance:
8602+
8603+
datadog\_api\_client.v2.model.incident\_notification\_rule\_included\_items module
8604+
----------------------------------------------------------------------------------
8605+
8606+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_included_items
8607+
:members:
8608+
:show-inheritance:
8609+
8610+
datadog\_api\_client.v2.model.incident\_notification\_rule\_relationships module
8611+
--------------------------------------------------------------------------------
8612+
8613+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_relationships
8614+
:members:
8615+
:show-inheritance:
8616+
8617+
datadog\_api\_client.v2.model.incident\_notification\_rule\_response\_data module
8618+
---------------------------------------------------------------------------------
8619+
8620+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_response_data
8621+
:members:
8622+
:show-inheritance:
8623+
8624+
datadog\_api\_client.v2.model.incident\_notification\_rule\_type module
8625+
-----------------------------------------------------------------------
8626+
8627+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_type
8628+
:members:
8629+
:show-inheritance:
8630+
8631+
datadog\_api\_client.v2.model.incident\_notification\_rule\_update\_data module
8632+
-------------------------------------------------------------------------------
8633+
8634+
.. automodule:: datadog_api_client.v2.model.incident_notification_rule_update_data
8635+
:members:
8636+
:show-inheritance:
8637+
85198638
datadog\_api\_client.v2.model.incident\_notification\_template module
85208639
---------------------------------------------------------------------
85218640

@@ -8579,6 +8698,13 @@ datadog\_api\_client.v2.model.incident\_notification\_template\_included\_items
85798698
:members:
85808699
:show-inheritance:
85818700

8701+
datadog\_api\_client.v2.model.incident\_notification\_template\_object module
8702+
-----------------------------------------------------------------------------
8703+
8704+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_object
8705+
:members:
8706+
:show-inheritance:
8707+
85828708
datadog\_api\_client.v2.model.incident\_notification\_template\_relationships module
85838709
------------------------------------------------------------------------------------
85848710

@@ -14823,6 +14949,13 @@ datadog\_api\_client.v2.model.publish\_app\_response module
1482314949
:members:
1482414950
:show-inheritance:
1482514951

14952+
datadog\_api\_client.v2.model.put\_incident\_notification\_rule\_request module
14953+
-------------------------------------------------------------------------------
14954+
14955+
.. automodule:: datadog_api_client.v2.model.put_incident_notification_rule_request
14956+
:members:
14957+
:show-inheritance:
14958+
1482614959
datadog\_api\_client.v2.model.query module
1482714960
------------------------------------------
1482814961

@@ -15012,6 +15145,20 @@ datadog\_api\_client.v2.model.relationship\_to\_incident\_integration\_metadatas
1501215145
:members:
1501315146
:show-inheritance:
1501415147

15148+
datadog\_api\_client.v2.model.relationship\_to\_incident\_notification\_template module
15149+
---------------------------------------------------------------------------------------
15150+
15151+
.. automodule:: datadog_api_client.v2.model.relationship_to_incident_notification_template
15152+
:members:
15153+
:show-inheritance:
15154+
15155+
datadog\_api\_client.v2.model.relationship\_to\_incident\_notification\_template\_data module
15156+
---------------------------------------------------------------------------------------------
15157+
15158+
.. automodule:: datadog_api_client.v2.model.relationship_to_incident_notification_template_data
15159+
:members:
15160+
:show-inheritance:
15161+
1501515162
datadog\_api\_client.v2.model.relationship\_to\_incident\_postmortem module
1501615163
---------------------------------------------------------------------------
1501715164

‎examples/v2/incidents/CreateIncidentNotificationRule.py‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
"""
2+
Create an incident notification rule returns "Created" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.incidents_api import IncidentsApi
7+
from datadog_api_client.v2.model.create_incident_notification_rule_request import CreateIncidentNotificationRuleRequest
8+
from datadog_api_client.v2.model.incident_notification_rule_conditions_items import (
9+
IncidentNotificationRuleConditionsItems,
10+
)
11+
from datadog_api_client.v2.model.incident_notification_rule_create_attributes import (
12+
IncidentNotificationRuleCreateAttributes,
13+
)
14+
from datadog_api_client.v2.model.incident_notification_rule_create_attributes_visibility import (
15+
IncidentNotificationRuleCreateAttributesVisibility,
16+
)
17+
from datadog_api_client.v2.model.incident_notification_rule_create_data import IncidentNotificationRuleCreateData
18+
from datadog_api_client.v2.model.incident_notification_rule_create_data_relationships import (
19+
IncidentNotificationRuleCreateDataRelationships,
20+
)
21+
from datadog_api_client.v2.model.incident_notification_rule_type import IncidentNotificationRuleType
22+
from datadog_api_client.v2.model.incident_notification_template_type import IncidentNotificationTemplateType
23+
from datadog_api_client.v2.model.incident_type_type import IncidentTypeType
24+
from datadog_api_client.v2.model.relationship_to_incident_notification_template import (
25+
RelationshipToIncidentNotificationTemplate,
26+
)
27+
from datadog_api_client.v2.model.relationship_to_incident_notification_template_data import (
28+
RelationshipToIncidentNotificationTemplateData,
29+
)
30+
from datadog_api_client.v2.model.relationship_to_incident_type import RelationshipToIncidentType
31+
from datadog_api_client.v2.model.relationship_to_incident_type_data import RelationshipToIncidentTypeData
32+
from uuid import UUID
33+
34+
body = CreateIncidentNotificationRuleRequest(
35+
data=IncidentNotificationRuleCreateData(
36+
attributes=IncidentNotificationRuleCreateAttributes(
37+
conditions=[
38+
IncidentNotificationRuleConditionsItems(
39+
field="severity",
40+
values=[
41+
"SEV-1",
42+
"SEV-2",
43+
],
44+
),
45+
],
46+
enabled=True,
47+
handles=[
48+
"@team-email@company.com",
49+
"@slack-channel",
50+
],
51+
renotify_on=[
52+
"status",
53+
"severity",
54+
],
55+
trigger="incident_created_trigger",
56+
visibility=IncidentNotificationRuleCreateAttributesVisibility.ORGANIZATION,
57+
),
58+
relationships=IncidentNotificationRuleCreateDataRelationships(
59+
incident_type=RelationshipToIncidentType(
60+
data=RelationshipToIncidentTypeData(
61+
id="00000000-0000-0000-0000-000000000000",
62+
type=IncidentTypeType.INCIDENT_TYPES,
63+
),
64+
),
65+
notification_template=RelationshipToIncidentNotificationTemplate(
66+
data=RelationshipToIncidentNotificationTemplateData(
67+
id=UUID("00000000-0000-0000-0000-000000000001"),
68+
type=IncidentNotificationTemplateType.NOTIFICATION_TEMPLATES,
69+
),
70+
),
71+
),
72+
type=IncidentNotificationRuleType.INCIDENT_NOTIFICATION_RULES,
73+
),
74+
)
75+
76+
configuration = Configuration()
77+
configuration.unstable_operations["create_incident_notification_rule"] = True
78+
with ApiClient(configuration) as api_client:
79+
api_instance = IncidentsApi(api_client)
80+
response = api_instance.create_incident_notification_rule(body=body)
81+
82+
print(response)

‎examples/v2/incidents/CreateIncidentNotificationRule_3029800608.py‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
"""
2+
Create incident notification rule returns "Created" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.incidents_api import IncidentsApi
8+
from datadog_api_client.v2.model.create_incident_notification_rule_request import CreateIncidentNotificationRuleRequest
9+
from datadog_api_client.v2.model.incident_notification_rule_conditions_items import (
10+
IncidentNotificationRuleConditionsItems,
11+
)
12+
from datadog_api_client.v2.model.incident_notification_rule_create_attributes import (
13+
IncidentNotificationRuleCreateAttributes,
14+
)
15+
from datadog_api_client.v2.model.incident_notification_rule_create_attributes_visibility import (
16+
IncidentNotificationRuleCreateAttributesVisibility,
17+
)
18+
from datadog_api_client.v2.model.incident_notification_rule_create_data import IncidentNotificationRuleCreateData
19+
from datadog_api_client.v2.model.incident_notification_rule_create_data_relationships import (
20+
IncidentNotificationRuleCreateDataRelationships,
21+
)
22+
from datadog_api_client.v2.model.incident_notification_rule_type import IncidentNotificationRuleType
23+
from datadog_api_client.v2.model.incident_type_type import IncidentTypeType
24+
from datadog_api_client.v2.model.relationship_to_incident_type import RelationshipToIncidentType
25+
from datadog_api_client.v2.model.relationship_to_incident_type_data import RelationshipToIncidentTypeData
26+
27+
# there is a valid "incident_type" in the system
28+
INCIDENT_TYPE_DATA_ID = environ["INCIDENT_TYPE_DATA_ID"]
29+
30+
body = CreateIncidentNotificationRuleRequest(
31+
data=IncidentNotificationRuleCreateData(
32+
attributes=IncidentNotificationRuleCreateAttributes(
33+
conditions=[
34+
IncidentNotificationRuleConditionsItems(
35+
field="severity",
36+
values=[
37+
"SEV-1",
38+
"SEV-2",
39+
],
40+
),
41+
],
42+
handles=[
43+
"@test-email@company.com",
44+
],
45+
visibility=IncidentNotificationRuleCreateAttributesVisibility.ORGANIZATION,
46+
trigger="incident_created_trigger",
47+
enabled=True,
48+
),
49+
relationships=IncidentNotificationRuleCreateDataRelationships(
50+
incident_type=RelationshipToIncidentType(
51+
data=RelationshipToIncidentTypeData(
52+
id=INCIDENT_TYPE_DATA_ID,
53+
type=IncidentTypeType.INCIDENT_TYPES,
54+
),
55+
),
56+
),
57+
type=IncidentNotificationRuleType.INCIDENT_NOTIFICATION_RULES,
58+
),
59+
)
60+
61+
configuration = Configuration()
62+
configuration.unstable_operations["create_incident_notification_rule"] = True
63+
with ApiClient(configuration) as api_client:
64+
api_instance = IncidentsApi(api_client)
65+
response = api_instance.create_incident_notification_rule(body=body)
66+
67+
print(response)

‎examples/v2/incidents/DeleteIncidentNotificationRule.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""
2+
Delete an incident notification rule returns "No Content" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.incidents_api import IncidentsApi
7+
from uuid import UUID
8+
9+
configuration = Configuration()
10+
configuration.unstable_operations["delete_incident_notification_rule"] = True
11+
with ApiClient(configuration) as api_client:
12+
api_instance = IncidentsApi(api_client)
13+
api_instance.delete_incident_notification_rule(
14+
id=UUID("00000000-0000-0000-0000-000000000001"),
15+
)

‎examples/v2/incidents/DeleteIncidentNotificationRule_4148107167.py‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
"""
2+
Delete incident notification rule returns "No Content" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.incidents_api import IncidentsApi
8+
9+
# there is a valid "notification_rule" in the system
10+
NOTIFICATION_RULE_DATA_ID = environ["NOTIFICATION_RULE_DATA_ID"]
11+
12+
configuration = Configuration()
13+
configuration.unstable_operations["delete_incident_notification_rule"] = True
14+
with ApiClient(configuration) as api_client:
15+
api_instance = IncidentsApi(api_client)
16+
api_instance.delete_incident_notification_rule(
17+
id=NOTIFICATION_RULE_DATA_ID,
18+
)

‎examples/v2/incidents/GetIncidentNotificationRule.py‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
"""
2+
Get an incident notification rule returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.incidents_api import IncidentsApi
7+
from uuid import UUID
8+
9+
configuration = Configuration()
10+
configuration.unstable_operations["get_incident_notification_rule"] = True
11+
with ApiClient(configuration) as api_client:
12+
api_instance = IncidentsApi(api_client)
13+
response = api_instance.get_incident_notification_rule(
14+
id=UUID("00000000-0000-0000-0000-000000000001"),
15+
)
16+
17+
print(response)

0 commit comments

Comments
 (0)