Skip to content

Add Annotations API v2 spec #3870

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 Annotations API v2 spec #3870

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
782 changes: 782 additions & 0 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/annotations/CreateAnnotation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
// Create an annotation returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.AnnotationsApi;
import com.datadog.api.client.v2.model.AnnotationColor;
import com.datadog.api.client.v2.model.AnnotationCreateAttributes;
import com.datadog.api.client.v2.model.AnnotationCreateData;
import com.datadog.api.client.v2.model.AnnotationCreateRequest;
import com.datadog.api.client.v2.model.AnnotationKind;
import com.datadog.api.client.v2.model.AnnotationResponse;
import com.datadog.api.client.v2.model.AnnotationType;
import java.util.Collections;

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

AnnotationCreateRequest body =
new AnnotationCreateRequest()
.data(
new AnnotationCreateData()
.attributes(
new AnnotationCreateAttributes()
.color(AnnotationColor.BLUE)
.description("Deployed v2.3.1 to production.")
.pageId("dashboard:abc-def-xyz")
.startTime(1704067200000L)
.type(AnnotationKind.POINT_IN_TIME)
.widgetIds(Collections.singletonList("1234567890")))
.type(AnnotationType.ANNOTATION));

try {
AnnotationResponse result = apiInstance.createAnnotation(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnnotationsApi#createAnnotation");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
24 changes: 24 additions & 0 deletions examples/v2/annotations/DeleteAnnotation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// Delete an annotation returns "No Content" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.AnnotationsApi;
import java.util.UUID;

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

try {
apiInstance.deleteAnnotation(UUID.fromString("00000000-0000-0000-0000-000000000000"));
} catch (ApiException e) {
System.err.println("Exception when calling AnnotationsApi#deleteAnnotation");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
31 changes: 31 additions & 0 deletions examples/v2/annotations/DeleteAnnotation_1252790110.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
// Delete an annotation returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.AnnotationsApi;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
AnnotationsApi apiInstance = new AnnotationsApi(defaultClient);

// there is a valid "annotation" in the system
UUID ANNOTATION_DATA_ID = null;
try {
ANNOTATION_DATA_ID = UUID.fromString(System.getenv("ANNOTATION_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

try {
apiInstance.deleteAnnotation(ANNOTATION_DATA_ID);
} catch (ApiException e) {
System.err.println("Exception when calling AnnotationsApi#deleteAnnotation");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
30 changes: 30 additions & 0 deletions examples/v2/annotations/GetPageAnnotations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// Get annotations for a page returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.AnnotationsApi;
import com.datadog.api.client.v2.model.PageAnnotationsResponse;

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

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

try {
PageAnnotationsResponse result =
apiInstance.getPageAnnotations(
ANNOTATION_DATA_ATTRIBUTES_PAGE_ID, 1704067200000L, 1704153600000L);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnnotationsApi#getPageAnnotations");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
30 changes: 30 additions & 0 deletions examples/v2/annotations/ListAnnotations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// List annotations returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.AnnotationsApi;
import com.datadog.api.client.v2.model.AnnotationsResponse;

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

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

try {
AnnotationsResponse result =
apiInstance.listAnnotations(
ANNOTATION_DATA_ATTRIBUTES_PAGE_ID, 1704067200000L, 1704153600000L);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnnotationsApi#listAnnotations");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
53 changes: 53 additions & 0 deletions examples/v2/annotations/UpdateAnnotation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
// Update an annotation returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.AnnotationsApi;
import com.datadog.api.client.v2.model.AnnotationColor;
import com.datadog.api.client.v2.model.AnnotationCreateAttributes;
import com.datadog.api.client.v2.model.AnnotationKind;
import com.datadog.api.client.v2.model.AnnotationResponse;
import com.datadog.api.client.v2.model.AnnotationType;
import com.datadog.api.client.v2.model.AnnotationUpdateData;
import com.datadog.api.client.v2.model.AnnotationUpdateRequest;
import java.util.UUID;

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

// there is a valid "annotation" in the system
UUID ANNOTATION_DATA_ID = null;
try {
ANNOTATION_DATA_ID = UUID.fromString(System.getenv("ANNOTATION_DATA_ID"));
} catch (IllegalArgumentException e) {
System.err.println("Error parsing UUID: " + e.getMessage());
}

AnnotationUpdateRequest body =
new AnnotationUpdateRequest()
.data(
new AnnotationUpdateData()
.attributes(
new AnnotationCreateAttributes()
.color(AnnotationColor.GREEN)
.description("Updated annotation.")
.pageId("dashboard:abc-def-xyz")
.startTime(1704067200000L)
.type(AnnotationKind.POINT_IN_TIME))
.type(AnnotationType.ANNOTATION));

try {
AnnotationResponse result = apiInstance.updateAnnotation(ANNOTATION_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnnotationsApi#updateAnnotation");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
5 changes: 5 additions & 0 deletions 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 @@ -817,6 +817,11 @@ public class ApiClient {
put("v2.updateLLMObsDatasetRecords", false);
put("v2.updateLLMObsExperiment", false);
put("v2.updateLLMObsProject", false);
put("v2.createAnnotation", false);
put("v2.deleteAnnotation", false);
put("v2.getPageAnnotations", false);
put("v2.listAnnotations", false);
put("v2.updateAnnotation", false);
put("v2.anonymizeUsers", false);
put("v2.validate", false);
put("v2.createOpenAPI", false);
Expand Down
Loading
Loading