Skip to content

Add documentation for GET, POST, PATCH, and DELETE api/v2/incidents/incident_id/attachments endpoints #3296

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

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation for GET, POST, PATCH, and DELETE api/v2/incidents/incident_id/attachments endpoints #3296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
645 changes: 338 additions & 307 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

46 changes: 46 additions & 0 deletions examples/v2/incidents/CreateIncidentAttachment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
// Create incident attachment returns "Created" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.Attachment;
import com.datadog.api.client.v2.model.AttachmentDataAttributesAttachmentType;
import com.datadog.api.client.v2.model.CreateAttachmentRequest;
import com.datadog.api.client.v2.model.CreateAttachmentRequestData;
import com.datadog.api.client.v2.model.CreateAttachmentRequestDataAttributes;
import com.datadog.api.client.v2.model.CreateAttachmentRequestDataAttributesAttachment;
import com.datadog.api.client.v2.model.IncidentAttachmentType;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createIncidentAttachment", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);

CreateAttachmentRequest body =
new CreateAttachmentRequest()
.data(
new CreateAttachmentRequestData()
.attributes(
new CreateAttachmentRequestDataAttributes()
.attachment(
new CreateAttachmentRequestDataAttributesAttachment()
.documentUrl(
"https://app.datadoghq.com/notebook/123/Postmortem-IR-123")
.title("Postmortem-IR-123"))
.attachmentType(AttachmentDataAttributesAttachmentType.POSTMORTEM))
.id("00000000-0000-0000-0000-000000000000")
.type(IncidentAttachmentType.INCIDENT_ATTACHMENTS));

try {
Attachment result = apiInstance.createIncidentAttachment("incident_id", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#createIncidentAttachment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
13 changes: 4 additions & 9 deletions ...s/ListIncidentAttachments_2457735435.java → ...2/incidents/DeleteIncidentAttachment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,19 @@
// Get incident attachments returns "OK" response
// Delete incident attachment returns "No Content" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.IncidentAttachmentsResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.listIncidentAttachments", true);
defaultClient.setUnstableOperationEnabled("v2.deleteIncidentAttachment", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);

// there is a valid "incident" in the system
String INCIDENT_DATA_ID = System.getenv("INCIDENT_DATA_ID");

try {
IncidentAttachmentsResponse result = apiInstance.listIncidentAttachments(INCIDENT_DATA_ID);
System.out.println(result);
apiInstance.deleteIncidentAttachment("incident_id", "00000000-0000-0000-0000-000000000002");
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#listIncidentAttachments");
System.err.println("Exception when calling IncidentsApi#deleteIncidentAttachment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
Expand Down
6 changes: 3 additions & 3 deletions examples/v2/incidents/ListIncidentAttachments.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// Get a list of attachments returns "OK" response
// List incident attachments returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.IncidentAttachmentsResponse;
import com.datadog.api.client.v2.model.AttachmentArray;

public class Example {
public static void main(String[] args) {
Expand All @@ -12,7 +12,7 @@ public static void main(String[] args) {
IncidentsApi apiInstance = new IncidentsApi(defaultClient);

try {
IncidentAttachmentsResponse result = apiInstance.listIncidentAttachments("incident_id");
AttachmentArray result = apiInstance.listIncidentAttachments("incident_id");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#listIncidentAttachments");
Expand Down
45 changes: 45 additions & 0 deletions examples/v2/incidents/UpdateIncidentAttachment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// Update incident attachment returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.Attachment;
import com.datadog.api.client.v2.model.IncidentAttachmentType;
import com.datadog.api.client.v2.model.PatchAttachmentRequest;
import com.datadog.api.client.v2.model.PatchAttachmentRequestData;
import com.datadog.api.client.v2.model.PatchAttachmentRequestDataAttributes;
import com.datadog.api.client.v2.model.PatchAttachmentRequestDataAttributesAttachment;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.updateIncidentAttachment", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);

PatchAttachmentRequest body =
new PatchAttachmentRequest()
.data(
new PatchAttachmentRequestData()
.attributes(
new PatchAttachmentRequestDataAttributes()
.attachment(
new PatchAttachmentRequestDataAttributesAttachment()
.documentUrl(
"https://app.datadoghq.com/notebook/124/Postmortem-IR-124")
.title("Postmortem-IR-124")))
.type(IncidentAttachmentType.INCIDENT_ATTACHMENTS));

try {
Attachment result =
apiInstance.updateIncidentAttachment(
"incident_id", "00000000-0000-0000-0000-000000000002", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#updateIncidentAttachment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
68 changes: 0 additions & 68 deletions examples/v2/incidents/UpdateIncidentAttachments.java
View file
Open in desktop

This file was deleted.

52 changes: 0 additions & 52 deletions examples/v2/incidents/UpdateIncidentAttachments_3881702075.java
View file
Open in desktop

This file was deleted.

4 changes: 3 additions & 1 deletion src/main/java/com/datadog/api/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -744,13 +744,15 @@ public class ApiClient {
put("v2.updateDeploymentGate", false);
put("v2.updateDeploymentRule", false);
put("v2.createIncident", false);
put("v2.createIncidentAttachment", false);
put("v2.createIncidentImpact", false);
put("v2.createIncidentIntegration", false);
put("v2.createIncidentNotificationRule", false);
put("v2.createIncidentNotificationTemplate", false);
put("v2.createIncidentTodo", false);
put("v2.createIncidentType", false);
put("v2.deleteIncident", false);
put("v2.deleteIncidentAttachment", false);
put("v2.deleteIncidentImpact", false);
put("v2.deleteIncidentIntegration", false);
put("v2.deleteIncidentNotificationRule", false);
Expand All @@ -773,7 +775,7 @@ public class ApiClient {
put("v2.listIncidentTypes", false);
put("v2.searchIncidents", false);
put("v2.updateIncident", false);
put("v2.updateIncidentAttachments", false);
put("v2.updateIncidentAttachment", false);
put("v2.updateIncidentIntegration", false);
put("v2.updateIncidentNotificationRule", false);
put("v2.updateIncidentNotificationTemplate", false);
Expand Down
Loading
Loading