Skip to content

Commit 194f0ea

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 Template Public Docs (#2819)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 110582d commit 194f0ea

File tree

58 files changed

+3346
-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

+3346
-1
lines changed

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

Lines changed: 613 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 175 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\_template\_request module
4341+
--------------------------------------------------------------------------------------
4342+
4343+
.. automodule:: datadog_api_client.v2.model.create_incident_notification_template_request
4344+
:members:
4345+
:show-inheritance:
4346+
43404347
datadog\_api\_client.v2.model.create\_notification\_rule\_parameters module
43414348
---------------------------------------------------------------------------
43424349

@@ -7893,6 +7900,20 @@ datadog\_api\_client.v2.model.gitlab\_integration\_update module
78937900
:members:
78947901
:show-inheritance:
78957902

7903+
datadog\_api\_client.v2.model.google\_meet\_configuration\_reference module
7904+
---------------------------------------------------------------------------
7905+
7906+
.. automodule:: datadog_api_client.v2.model.google_meet_configuration_reference
7907+
:members:
7908+
:show-inheritance:
7909+
7910+
datadog\_api\_client.v2.model.google\_meet\_configuration\_reference\_data module
7911+
---------------------------------------------------------------------------------
7912+
7913+
.. automodule:: datadog_api_client.v2.model.google_meet_configuration_reference_data
7914+
:members:
7915+
:show-inheritance:
7916+
78967917
datadog\_api\_client.v2.model.grey\_noise\_api\_key module
78977918
----------------------------------------------------------
78987919

@@ -8495,6 +8516,104 @@ datadog\_api\_client.v2.model.incident\_notification\_handle module
84958516
:members:
84968517
:show-inheritance:
84978518

8519+
datadog\_api\_client.v2.model.incident\_notification\_template module
8520+
---------------------------------------------------------------------
8521+
8522+
.. automodule:: datadog_api_client.v2.model.incident_notification_template
8523+
:members:
8524+
:show-inheritance:
8525+
8526+
datadog\_api\_client.v2.model.incident\_notification\_template\_array module
8527+
----------------------------------------------------------------------------
8528+
8529+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_array
8530+
:members:
8531+
:show-inheritance:
8532+
8533+
datadog\_api\_client.v2.model.incident\_notification\_template\_array\_meta module
8534+
----------------------------------------------------------------------------------
8535+
8536+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_array_meta
8537+
:members:
8538+
:show-inheritance:
8539+
8540+
datadog\_api\_client.v2.model.incident\_notification\_template\_array\_meta\_page module
8541+
----------------------------------------------------------------------------------------
8542+
8543+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_array_meta_page
8544+
:members:
8545+
:show-inheritance:
8546+
8547+
datadog\_api\_client.v2.model.incident\_notification\_template\_attributes module
8548+
---------------------------------------------------------------------------------
8549+
8550+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_attributes
8551+
:members:
8552+
:show-inheritance:
8553+
8554+
datadog\_api\_client.v2.model.incident\_notification\_template\_create\_attributes module
8555+
-----------------------------------------------------------------------------------------
8556+
8557+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_create_attributes
8558+
:members:
8559+
:show-inheritance:
8560+
8561+
datadog\_api\_client.v2.model.incident\_notification\_template\_create\_data module
8562+
-----------------------------------------------------------------------------------
8563+
8564+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_create_data
8565+
:members:
8566+
:show-inheritance:
8567+
8568+
datadog\_api\_client.v2.model.incident\_notification\_template\_create\_data\_relationships module
8569+
--------------------------------------------------------------------------------------------------
8570+
8571+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_create_data_relationships
8572+
:members:
8573+
:show-inheritance:
8574+
8575+
datadog\_api\_client.v2.model.incident\_notification\_template\_included\_items module
8576+
--------------------------------------------------------------------------------------
8577+
8578+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_included_items
8579+
:members:
8580+
:show-inheritance:
8581+
8582+
datadog\_api\_client.v2.model.incident\_notification\_template\_relationships module
8583+
------------------------------------------------------------------------------------
8584+
8585+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_relationships
8586+
:members:
8587+
:show-inheritance:
8588+
8589+
datadog\_api\_client.v2.model.incident\_notification\_template\_response\_data module
8590+
-------------------------------------------------------------------------------------
8591+
8592+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_response_data
8593+
:members:
8594+
:show-inheritance:
8595+
8596+
datadog\_api\_client.v2.model.incident\_notification\_template\_type module
8597+
---------------------------------------------------------------------------
8598+
8599+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_type
8600+
:members:
8601+
:show-inheritance:
8602+
8603+
datadog\_api\_client.v2.model.incident\_notification\_template\_update\_attributes module
8604+
-----------------------------------------------------------------------------------------
8605+
8606+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_update_attributes
8607+
:members:
8608+
:show-inheritance:
8609+
8610+
datadog\_api\_client.v2.model.incident\_notification\_template\_update\_data module
8611+
-----------------------------------------------------------------------------------
8612+
8613+
.. automodule:: datadog_api_client.v2.model.incident_notification_template_update_data
8614+
:members:
8615+
:show-inheritance:
8616+
84988617
datadog\_api\_client.v2.model.incident\_postmortem\_type module
84998618
---------------------------------------------------------------
85008619

@@ -9048,6 +9167,13 @@ datadog\_api\_client.v2.model.incident\_type\_patch\_request module
90489167
:members:
90499168
:show-inheritance:
90509169

9170+
datadog\_api\_client.v2.model.incident\_type\_relationships module
9171+
------------------------------------------------------------------
9172+
9173+
.. automodule:: datadog_api_client.v2.model.incident_type_relationships
9174+
:members:
9175+
:show-inheritance:
9176+
90519177
datadog\_api\_client.v2.model.incident\_type\_response module
90529178
-------------------------------------------------------------
90539179

@@ -11414,6 +11540,20 @@ datadog\_api\_client.v2.model.microsoft\_teams\_channel\_info\_type module
1141411540
:members:
1141511541
:show-inheritance:
1141611542

11543+
datadog\_api\_client.v2.model.microsoft\_teams\_configuration\_reference module
11544+
-------------------------------------------------------------------------------
11545+
11546+
.. automodule:: datadog_api_client.v2.model.microsoft_teams_configuration_reference
11547+
:members:
11548+
:show-inheritance:
11549+
11550+
datadog\_api\_client.v2.model.microsoft\_teams\_configuration\_reference\_data module
11551+
-------------------------------------------------------------------------------------
11552+
11553+
.. automodule:: datadog_api_client.v2.model.microsoft_teams_configuration_reference_data
11554+
:members:
11555+
:show-inheritance:
11556+
1141711557
datadog\_api\_client.v2.model.microsoft\_teams\_create\_tenant\_based\_handle\_request module
1141811558
---------------------------------------------------------------------------------------------
1141911559

@@ -14375,6 +14515,13 @@ datadog\_api\_client.v2.model.partial\_application\_key\_response module
1437514515
:members:
1437614516
:show-inheritance:
1437714517

14518+
datadog\_api\_client.v2.model.patch\_incident\_notification\_template\_request module
14519+
-------------------------------------------------------------------------------------
14520+
14521+
.. automodule:: datadog_api_client.v2.model.patch_incident_notification_template_request
14522+
:members:
14523+
:show-inheritance:
14524+
1437814525
datadog\_api\_client.v2.model.patch\_notification\_rule\_parameters module
1437914526
--------------------------------------------------------------------------
1438014527

@@ -14893,6 +15040,20 @@ datadog\_api\_client.v2.model.relationship\_to\_incident\_responders module
1489315040
:members:
1489415041
:show-inheritance:
1489515042

15043+
datadog\_api\_client.v2.model.relationship\_to\_incident\_type module
15044+
---------------------------------------------------------------------
15045+
15046+
.. automodule:: datadog_api_client.v2.model.relationship_to_incident_type
15047+
:members:
15048+
:show-inheritance:
15049+
15050+
datadog\_api\_client.v2.model.relationship\_to\_incident\_type\_data module
15051+
---------------------------------------------------------------------------
15052+
15053+
.. automodule:: datadog_api_client.v2.model.relationship_to_incident_type_data
15054+
:members:
15055+
:show-inheritance:
15056+
1489615057
datadog\_api\_client.v2.model.relationship\_to\_incident\_user\_defined\_field\_data module
1489715058
-------------------------------------------------------------------------------------------
1489815059

@@ -20969,6 +21130,20 @@ datadog\_api\_client.v2.model.x\_ray\_services\_list module
2096921130
:members:
2097021131
:show-inheritance:
2097121132

21133+
datadog\_api\_client.v2.model.zoom\_configuration\_reference module
21134+
-------------------------------------------------------------------
21135+
21136+
.. automodule:: datadog_api_client.v2.model.zoom_configuration_reference
21137+
:members:
21138+
:show-inheritance:
21139+
21140+
datadog\_api\_client.v2.model.zoom\_configuration\_reference\_data module
21141+
-------------------------------------------------------------------------
21142+
21143+
.. automodule:: datadog_api_client.v2.model.zoom_configuration_reference_data
21144+
:members:
21145+
:show-inheritance:
21146+
2097221147
Module contents
2097321148
---------------
2097421149

‎examples/v2/incidents/CreateIncidentNotificationTemplate.py‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
"""
2+
Create incident notification template 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_template_request import (
9+
CreateIncidentNotificationTemplateRequest,
10+
)
11+
from datadog_api_client.v2.model.incident_notification_template_create_attributes import (
12+
IncidentNotificationTemplateCreateAttributes,
13+
)
14+
from datadog_api_client.v2.model.incident_notification_template_create_data import (
15+
IncidentNotificationTemplateCreateData,
16+
)
17+
from datadog_api_client.v2.model.incident_notification_template_create_data_relationships import (
18+
IncidentNotificationTemplateCreateDataRelationships,
19+
)
20+
from datadog_api_client.v2.model.incident_notification_template_type import IncidentNotificationTemplateType
21+
from datadog_api_client.v2.model.incident_type_type import IncidentTypeType
22+
from datadog_api_client.v2.model.relationship_to_incident_type import RelationshipToIncidentType
23+
from datadog_api_client.v2.model.relationship_to_incident_type_data import RelationshipToIncidentTypeData
24+
25+
# there is a valid "incident_type" in the system
26+
INCIDENT_TYPE_DATA_ID = environ["INCIDENT_TYPE_DATA_ID"]
27+
28+
body = CreateIncidentNotificationTemplateRequest(
29+
data=IncidentNotificationTemplateCreateData(
30+
attributes=IncidentNotificationTemplateCreateAttributes(
31+
category="alert",
32+
content="An incident has been declared.\n\nTitle: Sample Incident Title\nSeverity: SEV-2\nAffected Services: web-service, database-service\nStatus: active\n\nPlease join the incident channel for updates.",
33+
name="Example-Incident",
34+
subject="SEV-2 Incident: Sample Incident Title",
35+
),
36+
relationships=IncidentNotificationTemplateCreateDataRelationships(
37+
incident_type=RelationshipToIncidentType(
38+
data=RelationshipToIncidentTypeData(
39+
id=INCIDENT_TYPE_DATA_ID,
40+
type=IncidentTypeType.INCIDENT_TYPES,
41+
),
42+
),
43+
),
44+
type=IncidentNotificationTemplateType.NOTIFICATION_TEMPLATES,
45+
),
46+
)
47+
48+
configuration = Configuration()
49+
configuration.unstable_operations["create_incident_notification_template"] = True
50+
with ApiClient(configuration) as api_client:
51+
api_instance = IncidentsApi(api_client)
52+
response = api_instance.create_incident_notification_template(body=body)
53+
54+
print(response)

‎examples/v2/incidents/DeleteIncidentNotificationTemplate.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""
2+
Delete a notification template 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_template"] = True
11+
with ApiClient(configuration) as api_client:
12+
api_instance = IncidentsApi(api_client)
13+
api_instance.delete_incident_notification_template(
14+
id=UUID("00000000-0000-0000-0000-000000000001"),
15+
)

‎examples/v2/incidents/DeleteIncidentNotificationTemplate_1602689347.py‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
"""
2+
Delete incident notification template 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_template" in the system
10+
NOTIFICATION_TEMPLATE_DATA_ID = environ["NOTIFICATION_TEMPLATE_DATA_ID"]
11+
12+
configuration = Configuration()
13+
configuration.unstable_operations["delete_incident_notification_template"] = True
14+
with ApiClient(configuration) as api_client:
15+
api_instance = IncidentsApi(api_client)
16+
api_instance.delete_incident_notification_template(
17+
id=NOTIFICATION_TEMPLATE_DATA_ID,
18+
)

‎examples/v2/incidents/GetIncidentNotificationTemplate.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
"""
2+
Get incident notification template returns "OK" 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_template" in the system
10+
NOTIFICATION_TEMPLATE_DATA_ID = environ["NOTIFICATION_TEMPLATE_DATA_ID"]
11+
12+
configuration = Configuration()
13+
configuration.unstable_operations["get_incident_notification_template"] = True
14+
with ApiClient(configuration) as api_client:
15+
api_instance = IncidentsApi(api_client)
16+
response = api_instance.get_incident_notification_template(
17+
id=NOTIFICATION_TEMPLATE_DATA_ID,
18+
)
19+
20+
print(response)

‎examples/v2/incidents/ListIncidentNotificationTemplates.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""
2+
List incident notification templates 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+
8+
configuration = Configuration()
9+
configuration.unstable_operations["list_incident_notification_templates"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = IncidentsApi(api_client)
12+
response = api_instance.list_incident_notification_templates()
13+
14+
print(response)

‎examples/v2/incidents/UpdateIncidentNotificationTemplate.py‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
"""
2+
Update incident notification template returns "OK" 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.incident_notification_template_type import IncidentNotificationTemplateType
9+
from datadog_api_client.v2.model.incident_notification_template_update_attributes import (
10+
IncidentNotificationTemplateUpdateAttributes,
11+
)
12+
from datadog_api_client.v2.model.incident_notification_template_update_data import (
13+
IncidentNotificationTemplateUpdateData,
14+
)
15+
from datadog_api_client.v2.model.patch_incident_notification_template_request import (
16+
PatchIncidentNotificationTemplateRequest,
17+
)
18+
19+
# there is a valid "notification_template" in the system
20+
NOTIFICATION_TEMPLATE_DATA_ID = environ["NOTIFICATION_TEMPLATE_DATA_ID"]
21+
22+
body = PatchIncidentNotificationTemplateRequest(
23+
data=IncidentNotificationTemplateUpdateData(
24+
attributes=IncidentNotificationTemplateUpdateAttributes(
25+
category="update",
26+
content="Incident Status Update:\n\nTitle: Sample Incident Title\nNew Status: resolved\nSeverity: SEV-2\nServices: web-service, database-service\nCommander: John Doe\n\nFor more details, visit the incident page.",
27+
name="Example-Incident",
28+
subject="Incident Update: Sample Incident Title - resolved",
29+
),
30+
id=NOTIFICATION_TEMPLATE_DATA_ID,
31+
type=IncidentNotificationTemplateType.NOTIFICATION_TEMPLATES,
32+
),
33+
)
34+
35+
configuration = Configuration()
36+
configuration.unstable_operations["update_incident_notification_template"] = True
37+
with ApiClient(configuration) as api_client:
38+
api_instance = IncidentsApi(api_client)
39+
response = api_instance.update_incident_notification_template(id=NOTIFICATION_TEMPLATE_DATA_ID, body=body)
40+
41+
print(response)

0 commit comments

Comments
 (0)