Skip to content

Commit 202ad60

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 (#3116)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 688019c commit 202ad60

File tree

59 files changed

+7771
-197
lines changed

Some content is hidden

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

59 files changed

+7771
-197
lines changed

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

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

‎examples/v2/incidents/CreateIncidentNotificationTemplate.java‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
// Create incident notification template returns "Created" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.IncidentsApi;
6+
import com.datadog.api.client.v2.model.CreateIncidentNotificationTemplateRequest;
7+
import com.datadog.api.client.v2.model.IncidentNotificationTemplate;
8+
import com.datadog.api.client.v2.model.IncidentNotificationTemplateCreateAttributes;
9+
import com.datadog.api.client.v2.model.IncidentNotificationTemplateCreateData;
10+
import com.datadog.api.client.v2.model.IncidentNotificationTemplateCreateDataRelationships;
11+
import com.datadog.api.client.v2.model.IncidentNotificationTemplateType;
12+
import com.datadog.api.client.v2.model.IncidentTypeType;
13+
import com.datadog.api.client.v2.model.RelationshipToIncidentType;
14+
import com.datadog.api.client.v2.model.RelationshipToIncidentTypeData;
15+
16+
public class Example {
17+
public static void main(String[] args) {
18+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
19+
defaultClient.setUnstableOperationEnabled("v2.createIncidentNotificationTemplate", true);
20+
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
21+
22+
// there is a valid "incident_type" in the system
23+
String INCIDENT_TYPE_DATA_ID = System.getenv("INCIDENT_TYPE_DATA_ID");
24+
25+
CreateIncidentNotificationTemplateRequest body =
26+
new CreateIncidentNotificationTemplateRequest()
27+
.data(
28+
new IncidentNotificationTemplateCreateData()
29+
.attributes(
30+
new IncidentNotificationTemplateCreateAttributes()
31+
.category("alert")
32+
.content(
33+
"""
34+
An incident has been declared.
35+
36+
Title: Sample Incident Title
37+
Severity: SEV-2
38+
Affected Services: web-service, database-service
39+
Status: active
40+
41+
Please join the incident channel for updates.
42+
""")
43+
.name("Example-Incident")
44+
.subject("SEV-2 Incident: Sample Incident Title"))
45+
.relationships(
46+
new IncidentNotificationTemplateCreateDataRelationships()
47+
.incidentType(
48+
new RelationshipToIncidentType()
49+
.data(
50+
new RelationshipToIncidentTypeData()
51+
.id(INCIDENT_TYPE_DATA_ID)
52+
.type(IncidentTypeType.INCIDENT_TYPES))))
53+
.type(IncidentNotificationTemplateType.NOTIFICATION_TEMPLATES));
54+
55+
try {
56+
IncidentNotificationTemplate result = apiInstance.createIncidentNotificationTemplate(body);
57+
System.out.println(result);
58+
} catch (ApiException e) {
59+
System.err.println("Exception when calling IncidentsApi#createIncidentNotificationTemplate");
60+
System.err.println("Status code: " + e.getCode());
61+
System.err.println("Reason: " + e.getResponseBody());
62+
System.err.println("Response headers: " + e.getResponseHeaders());
63+
e.printStackTrace();
64+
}
65+
}
66+
}

‎examples/v2/incidents/DeleteIncidentNotificationTemplate.java‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Delete a notification template returns "No Content" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.IncidentsApi;
6+
import java.util.UUID;
7+
8+
public class Example {
9+
public static void main(String[] args) {
10+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
11+
defaultClient.setUnstableOperationEnabled("v2.deleteIncidentNotificationTemplate", true);
12+
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
13+
14+
try {
15+
apiInstance.deleteIncidentNotificationTemplate(
16+
UUID.fromString("00000000-0000-0000-0000-000000000001"));
17+
} catch (ApiException e) {
18+
System.err.println("Exception when calling IncidentsApi#deleteIncidentNotificationTemplate");
19+
System.err.println("Status code: " + e.getCode());
20+
System.err.println("Reason: " + e.getResponseBody());
21+
System.err.println("Response headers: " + e.getResponseHeaders());
22+
e.printStackTrace();
23+
}
24+
}
25+
}

‎examples/v2/incidents/DeleteIncidentNotificationTemplate_1602689347.java‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// Delete incident notification template returns "No Content" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.IncidentsApi;
6+
import java.util.UUID;
7+
8+
public class Example {
9+
public static void main(String[] args) {
10+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
11+
defaultClient.setUnstableOperationEnabled("v2.deleteIncidentNotificationTemplate", true);
12+
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
13+
14+
// there is a valid "notification_template" in the system
15+
UUID NOTIFICATION_TEMPLATE_DATA_ID = null;
16+
try {
17+
NOTIFICATION_TEMPLATE_DATA_ID =
18+
UUID.fromString(System.getenv("NOTIFICATION_TEMPLATE_DATA_ID"));
19+
} catch (IllegalArgumentException e) {
20+
System.err.println("Error parsing UUID: " + e.getMessage());
21+
}
22+
23+
try {
24+
apiInstance.deleteIncidentNotificationTemplate(NOTIFICATION_TEMPLATE_DATA_ID);
25+
} catch (ApiException e) {
26+
System.err.println("Exception when calling IncidentsApi#deleteIncidentNotificationTemplate");
27+
System.err.println("Status code: " + e.getCode());
28+
System.err.println("Reason: " + e.getResponseBody());
29+
System.err.println("Response headers: " + e.getResponseHeaders());
30+
e.printStackTrace();
31+
}
32+
}
33+
}

‎examples/v2/incidents/GetIncidentNotificationTemplate.java‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
// Get incident notification template returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.IncidentsApi;
6+
import com.datadog.api.client.v2.model.IncidentNotificationTemplate;
7+
import java.util.UUID;
8+
9+
public class Example {
10+
public static void main(String[] args) {
11+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
12+
defaultClient.setUnstableOperationEnabled("v2.getIncidentNotificationTemplate", true);
13+
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
14+
15+
// there is a valid "notification_template" in the system
16+
UUID NOTIFICATION_TEMPLATE_DATA_ID = null;
17+
try {
18+
NOTIFICATION_TEMPLATE_DATA_ID =
19+
UUID.fromString(System.getenv("NOTIFICATION_TEMPLATE_DATA_ID"));
20+
} catch (IllegalArgumentException e) {
21+
System.err.println("Error parsing UUID: " + e.getMessage());
22+
}
23+
24+
try {
25+
IncidentNotificationTemplate result =
26+
apiInstance.getIncidentNotificationTemplate(NOTIFICATION_TEMPLATE_DATA_ID);
27+
System.out.println(result);
28+
} catch (ApiException e) {
29+
System.err.println("Exception when calling IncidentsApi#getIncidentNotificationTemplate");
30+
System.err.println("Status code: " + e.getCode());
31+
System.err.println("Reason: " + e.getResponseBody());
32+
System.err.println("Response headers: " + e.getResponseHeaders());
33+
e.printStackTrace();
34+
}
35+
}
36+
}

‎examples/v2/incidents/ListIncidentNotificationTemplates.java‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// List incident notification templates returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.IncidentsApi;
6+
import com.datadog.api.client.v2.model.IncidentNotificationTemplateArray;
7+
8+
public class Example {
9+
public static void main(String[] args) {
10+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
11+
defaultClient.setUnstableOperationEnabled("v2.listIncidentNotificationTemplates", true);
12+
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
13+
14+
try {
15+
IncidentNotificationTemplateArray result = apiInstance.listIncidentNotificationTemplates();
16+
System.out.println(result);
17+
} catch (ApiException e) {
18+
System.err.println("Exception when calling IncidentsApi#listIncidentNotificationTemplates");
19+
System.err.println("Status code: " + e.getCode());
20+
System.err.println("Reason: " + e.getResponseBody());
21+
System.err.println("Response headers: " + e.getResponseHeaders());
22+
e.printStackTrace();
23+
}
24+
}
25+
}

‎examples/v2/incidents/UpdateIncidentNotificationTemplate.java‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
// Update incident notification template returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.IncidentsApi;
6+
import com.datadog.api.client.v2.model.IncidentNotificationTemplate;
7+
import com.datadog.api.client.v2.model.IncidentNotificationTemplateType;
8+
import com.datadog.api.client.v2.model.IncidentNotificationTemplateUpdateAttributes;
9+
import com.datadog.api.client.v2.model.IncidentNotificationTemplateUpdateData;
10+
import com.datadog.api.client.v2.model.PatchIncidentNotificationTemplateRequest;
11+
import java.util.UUID;
12+
13+
public class Example {
14+
public static void main(String[] args) {
15+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
16+
defaultClient.setUnstableOperationEnabled("v2.updateIncidentNotificationTemplate", true);
17+
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
18+
19+
// there is a valid "notification_template" in the system
20+
UUID NOTIFICATION_TEMPLATE_DATA_ID = null;
21+
try {
22+
NOTIFICATION_TEMPLATE_DATA_ID =
23+
UUID.fromString(System.getenv("NOTIFICATION_TEMPLATE_DATA_ID"));
24+
} catch (IllegalArgumentException e) {
25+
System.err.println("Error parsing UUID: " + e.getMessage());
26+
}
27+
28+
PatchIncidentNotificationTemplateRequest body =
29+
new PatchIncidentNotificationTemplateRequest()
30+
.data(
31+
new IncidentNotificationTemplateUpdateData()
32+
.attributes(
33+
new IncidentNotificationTemplateUpdateAttributes()
34+
.category("update")
35+
.content(
36+
"""
37+
Incident Status Update:
38+
39+
Title: Sample Incident Title
40+
New Status: resolved
41+
Severity: SEV-2
42+
Services: web-service, database-service
43+
Commander: John Doe
44+
45+
For more details, visit the incident page.
46+
""")
47+
.name("Example-Incident")
48+
.subject("Incident Update: Sample Incident Title - resolved"))
49+
.id(NOTIFICATION_TEMPLATE_DATA_ID)
50+
.type(IncidentNotificationTemplateType.NOTIFICATION_TEMPLATES));
51+
52+
try {
53+
IncidentNotificationTemplate result =
54+
apiInstance.updateIncidentNotificationTemplate(NOTIFICATION_TEMPLATE_DATA_ID, body);
55+
System.out.println(result);
56+
} catch (ApiException e) {
57+
System.err.println("Exception when calling IncidentsApi#updateIncidentNotificationTemplate");
58+
System.err.println("Status code: " + e.getCode());
59+
System.err.println("Reason: " + e.getResponseBody());
60+
System.err.println("Response headers: " + e.getResponseHeaders());
61+
e.printStackTrace();
62+
}
63+
}
64+
}

‎src/main/java/com/datadog/api/client/ApiClient.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -720,25 +720,30 @@ public class ApiClient {
720720
put("v2.getDataDeletionRequests", false);
721721
put("v2.createIncident", false);
722722
put("v2.createIncidentIntegration", false);
723+
put("v2.createIncidentNotificationTemplate", false);
723724
put("v2.createIncidentTodo", false);
724725
put("v2.createIncidentType", false);
725726
put("v2.deleteIncident", false);
726727
put("v2.deleteIncidentIntegration", false);
728+
put("v2.deleteIncidentNotificationTemplate", false);
727729
put("v2.deleteIncidentTodo", false);
728730
put("v2.deleteIncidentType", false);
729731
put("v2.getIncident", false);
730732
put("v2.getIncidentIntegration", false);
733+
put("v2.getIncidentNotificationTemplate", false);
731734
put("v2.getIncidentTodo", false);
732735
put("v2.getIncidentType", false);
733736
put("v2.listIncidentAttachments", false);
734737
put("v2.listIncidentIntegrations", false);
738+
put("v2.listIncidentNotificationTemplates", false);
735739
put("v2.listIncidents", false);
736740
put("v2.listIncidentTodos", false);
737741
put("v2.listIncidentTypes", false);
738742
put("v2.searchIncidents", false);
739743
put("v2.updateIncident", false);
740744
put("v2.updateIncidentAttachments", false);
741745
put("v2.updateIncidentIntegration", false);
746+
put("v2.updateIncidentNotificationTemplate", false);
742747
put("v2.updateIncidentTodo", false);
743748
put("v2.updateIncidentType", false);
744749
put("v2.createAWSAccount", false);

0 commit comments

Comments
 (0)