Add Annotations API v2 spec

cassettes/features/v2/annotations/Create-an-annotation-returns-OK-response.frozen

@@ -0,0 +1 @@
+2026-05-27T20:28:17.108Z

cassettes/features/v2/annotations/Delete-an-annotation-returns-No-Content-response.frozen

@@ -0,0 +1 @@
+2026-05-27T20:28:17.632Z

cassettes/features/v2/annotations/Get-annotations-for-a-page-returns-OK-response.frozen

@@ -0,0 +1 @@
+2026-05-27T20:28:17.883Z

cassettes/features/v2/annotations/List-annotations-returns-OK-response.frozen

@@ -0,0 +1 @@
+2026-05-27T20:28:18.281Z

cassettes/features/v2/annotations/Update-an-annotation-returns-OK-response.frozen

@@ -0,0 +1 @@
+2026-05-27T20:28:18.537Z

examples/v2/annotations/CreateAnnotation.rb

@@ -0,0 +1,24 @@
+# Create an annotation returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.create_annotation".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::AnnotationsAPI.new
+
+body = DatadogAPIClient::V2::AnnotationCreateRequest.new({
+  data: DatadogAPIClient::V2::AnnotationRequestData.new({
+    attributes: DatadogAPIClient::V2::AnnotationCreateAttributes.new({
+      color: DatadogAPIClient::V2::AnnotationColor::BLUE,
+      description: "Deployed v2.3.1 to production.",
+      page_id: "dashboard:abc-def-xyz",
+      start_time: 1704067200000,
+      type: DatadogAPIClient::V2::AnnotationKind::POINT_IN_TIME,
+      widget_ids: [
+        "1234567890",
+      ],
+    }),
+    type: DatadogAPIClient::V2::AnnotationType::ANNOTATION,
+  }),
+})
+p api_instance.create_annotation(body)

examples/v2/annotations/DeleteAnnotation.rb

@@ -0,0 +1,11 @@
+# Delete an annotation returns "No Content" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.delete_annotation".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::AnnotationsAPI.new
+
+# there is a valid "annotation" in the system
+ANNOTATION_DATA_ID = ENV["ANNOTATION_DATA_ID"]
+api_instance.delete_annotation(ANNOTATION_DATA_ID)

examples/v2/annotations/GetPageAnnotations.rb

@@ -0,0 +1,11 @@
+# Get annotations for a page returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.get_page_annotations".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::AnnotationsAPI.new
+
+# there is a valid "annotation" in the system
+ANNOTATION_DATA_ATTRIBUTES_PAGE_ID = ENV["ANNOTATION_DATA_ATTRIBUTES_PAGE_ID"]
+p api_instance.get_page_annotations(ANNOTATION_DATA_ATTRIBUTES_PAGE_ID, 1704067200000, 1704153600000)

examples/v2/annotations/ListAnnotations.rb

@@ -0,0 +1,11 @@
+# List annotations returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.list_annotations".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::AnnotationsAPI.new
+
+# there is a valid "annotation" in the system
+ANNOTATION_DATA_ATTRIBUTES_PAGE_ID = ENV["ANNOTATION_DATA_ATTRIBUTES_PAGE_ID"]
+p api_instance.list_annotations(ANNOTATION_DATA_ATTRIBUTES_PAGE_ID, 1704067200000, 1704153600000)

examples/v2/annotations/UpdateAnnotation.rb

@@ -0,0 +1,24 @@
+# Update an annotation returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.update_annotation".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::AnnotationsAPI.new
+
+# there is a valid "annotation" in the system
+ANNOTATION_DATA_ID = ENV["ANNOTATION_DATA_ID"]
+
+body = DatadogAPIClient::V2::AnnotationUpdateRequest.new({
+  data: DatadogAPIClient::V2::AnnotationRequestData.new({
+    attributes: DatadogAPIClient::V2::AnnotationCreateAttributes.new({
+      color: DatadogAPIClient::V2::AnnotationColor::GREEN,
+      description: "Updated annotation.",
+      page_id: "dashboard:abc-def-xyz",
+      start_time: 1704067200000,
+      type: DatadogAPIClient::V2::AnnotationKind::POINT_IN_TIME,
+    }),
+    type: DatadogAPIClient::V2::AnnotationType::ANNOTATION,
+  }),
+})
+p api_instance.update_annotation(ANNOTATION_DATA_ID, body)