Merge master into datadog-api-spec/test/oliver/-apps-2099-app-builder-api-documentation

api-clients-generation-pipeline[bot] · web-flow · commit 4bfe39c03679 · 2025-01-10T23:01:31.000Z
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-08 14:02:25.736805",
-            "spec_repo_commit": "1920836f"
+            "regenerated": "2025-01-09 22:06:06.242932",
+            "spec_repo_commit": "8d40e082"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-08 14:02:25.752564",
-            "spec_repo_commit": "1920836f"
+            "regenerated": "2025-01-09 22:06:06.258111",
+            "spec_repo_commit": "8d40e082"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -5957,7 +5957,7 @@ components:
       - name
       type: object
     LogsPipelineList:
-      description: Array of pipeline ID strings.
+      description: Array of all log pipeline objects configured for the organization.
       items:
         $ref: '#/components/schemas/LogsPipeline'
       type: array
@@ -28873,7 +28873,7 @@ paths:
         - metrics_metadata_write
   /api/v1/monitor:
     get:
-      description: Get details about the specified monitor from your organization.
+      description: Get all monitors from your organization.
       operationId: ListMonitors
       parameters:
       - description: 'When specified, shows additional information about the group
@@ -28956,6 +28956,7 @@ paths:
           content:
             application/json:
               schema:
+                description: An array of monitor objects.
                 items:
                   $ref: '#/components/schemas/Monitor'
                 type: array
@@ -28979,7 +28980,7 @@ paths:
         appKeyAuth: []
       - AuthZ:
         - monitors_read
-      summary: Get all monitor details
+      summary: Get all monitors
       tags:
       - Monitors
       x-pagination:
@@ -36665,10 +36666,17 @@ tags:
     end times, prevent all alerting related to specified Datadog tags.'
   name: Downtimes
 - description: 'The Event Management API allows you to programmatically post events
-    to the Events Explorer
+    to the Events Explorer and fetch events from the Events Explorer. See the [Event
+    Management page](https://docs.datadoghq.com/service_management/events/) for more
+    information.
 
-    and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/)
-    for more information.'
+
+    **Update to Datadog monitor events `aggregation_key` starting March 1, 2025:**
+    The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting
+    March 1st, this key will also include Monitor Group, making it unique per *Monitor
+    ID and Monitor Group*. If you''re using monitor events `aggregation_key` in dashboard
+    queries or the Event API, you must migrate to use `@monitor.id`. Reach out to
+    [support](https://www.datadoghq.com/support/) if you have any question.'
   name: Events
 - description: 'Configure your Datadog-Google Cloud Platform (GCP) integration directly
 
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -48310,10 +48310,17 @@ tags:
     end times, prevent all alerting related to specified Datadog tags.'
   name: Downtimes
 - description: 'The Event Management API allows you to programmatically post events
-    to the Events Explorer
+    to the Events Explorer and fetch events from the Events Explorer. See the [Event
+    Management page](https://docs.datadoghq.com/service_management/events/) for more
+    information.
 
-    and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/)
-    for more information.'
+
+    **Update to Datadog monitor events `aggregation_key` starting March 1, 2025:**
+    The Datadog monitor events `aggregation_key` is unique to each Monitor ID. Starting
+    March 1st, this key will also include Monitor Group, making it unique per *Monitor
+    ID and Monitor Group*. If you''re using monitor events `aggregation_key` in dashboard
+    queries or the Event API, you must migrate to use `@monitor.id`. Reach out to
+    [support](https://www.datadoghq.com/support/) if you have any question.'
   name: Events
 - description: Manage your Datadog Fastly integration accounts and services directly
     through the Datadog API. See the [Fastly integration page](https://docs.datadoghq.com/integrations/fastly/)
diff --git a/cassettes/features/v1/monitors/Get-all-monitors-returns-Bad-Request-response.frozen b/cassettes/features/v1/monitors/Get-all-monitors-returns-Bad-Request-response.frozen
diff --git a/cassettes/features/v1/monitors/Get-all-monitors-returns-Bad-Request-response.yml b/cassettes/features/v1/monitors/Get-all-monitors-returns-Bad-Request-response.yml
diff --git a/cassettes/features/v1/monitors/Get-all-monitors-returns-OK-response-with-pagination.frozen b/cassettes/features/v1/monitors/Get-all-monitors-returns-OK-response-with-pagination.frozen
diff --git a/cassettes/features/v1/monitors/Get-all-monitors-returns-OK-response-with-pagination.yml b/cassettes/features/v1/monitors/Get-all-monitors-returns-OK-response-with-pagination.yml
diff --git a/examples/v1/monitors/ListMonitors.rb b/examples/v1/monitors/ListMonitors.rb
@@ -1,4 +1,4 @@
-# Get all monitor details returns "OK" response
+# Get all monitors returns "OK" response
 
 require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::MonitorsAPI.new
diff --git a/examples/v1/monitors/ListMonitors_2154432960.rb b/examples/v1/monitors/ListMonitors_2154432960.rb
@@ -1,4 +1,4 @@
-# Get all monitor details with tags
+# Get all monitors with tags
 
 require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::MonitorsAPI.new
diff --git a/examples/v1/monitors/ListMonitors_463213563.rb b/examples/v1/monitors/ListMonitors_463213563.rb
@@ -1,4 +1,4 @@
-# Get all monitor details returns "OK" response with pagination
+# Get all monitors returns "OK" response with pagination
 
 require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::MonitorsAPI.new
diff --git a/features/v1/events.feature b/features/v1/events.feature
@@ -3,7 +3,14 @@ Feature: Events
   The Event Management API allows you to programmatically post events to the
   Events Explorer and fetch events from the Events Explorer. See the [Event
   Management page](https://docs.datadoghq.com/service_management/events/)
-  for more information.
+  for more information.  **Update to Datadog monitor events
+  `aggregation_key` starting March 1, 2025:** The Datadog monitor events
+  `aggregation_key` is unique to each Monitor ID. Starting March 1st, this
+  key will also include Monitor Group, making it unique per *Monitor ID and
+  Monitor Group*. If you're using monitor events `aggregation_key` in
+  dashboard queries or the Event API, you must migrate to use `@monitor.id`.
+  Reach out to [support](https://www.datadoghq.com/support/) if you have any
+  question.
 
   Background:
     Given a valid "apiKeyAuth" key in the system
diff --git a/features/v1/monitors.feature b/features/v1/monitors.feature
@@ -227,28 +227,28 @@ Feature: Monitors
     And the response "options.synthetics_check_id" has the same value as "synthetics_api_test.public_id"
 
   @team:DataDog/monitor-app
-  Scenario: Get all monitor details returns "Bad Request" response
+  Scenario: Get all monitors returns "Bad Request" response
     Given new "ListMonitors" request
     And request contains "group_states" parameter with value "notagroupstate"
     When the request is sent
     Then the response status is 400 Bad Request
 
   @integration-only @team:DataDog/monitor-app
-  Scenario: Get all monitor details returns "OK" response
+  Scenario: Get all monitors returns "OK" response
     Given new "ListMonitors" request
     When the request is sent
     Then the response status is 200 OK
 
   @replay-only @skip-validation @team:DataDog/monitor-app @with-pagination
-  Scenario: Get all monitor details returns "OK" response with pagination
+  Scenario: Get all monitors returns "OK" response with pagination
     Given new "ListMonitors" request
     And request contains "page_size" parameter with value 2
     When the request with pagination is sent
     Then the response status is 200 OK
     And the response has 3 items
 
   @skip @team:DataDog/monitor-app
-  Scenario: Get all monitor details with tags
+  Scenario: Get all monitors with tags
     Given there is a valid "monitor" in the system
     And new "ListMonitors" request
     And request contains "tags" parameter with value "test:{{ unique_lower_alnum }}"
diff --git a/features/v2/events.feature b/features/v2/events.feature
@@ -3,7 +3,14 @@ Feature: Events
   The Event Management API allows you to programmatically post events to the
   Events Explorer and fetch events from the Events Explorer. See the [Event
   Management page](https://docs.datadoghq.com/service_management/events/)
-  for more information.
+  for more information.  **Update to Datadog monitor events
+  `aggregation_key` starting March 1, 2025:** The Datadog monitor events
+  `aggregation_key` is unique to each Monitor ID. Starting March 1st, this
+  key will also include Monitor Group, making it unique per *Monitor ID and
+  Monitor Group*. If you're using monitor events `aggregation_key` in
+  dashboard queries or the Event API, you must migrate to use `@monitor.id`.
+  Reach out to [support](https://www.datadoghq.com/support/) if you have any
+  question.
 
   Background:
     Given a valid "apiKeyAuth" key in the system
diff --git a/lib/datadog_api_client/v1/api/monitors_api.rb b/lib/datadog_api_client/v1/api/monitors_api.rb
@@ -485,17 +485,17 @@ def get_monitor_with_http_info(monitor_id, opts = {})
       return data, status_code, headers
     end
 
-    # Get all monitor details.
+    # Get all monitors.
     #
     # @see #list_monitors_with_http_info
     def list_monitors(opts = {})
       data, _status_code, _headers = list_monitors_with_http_info(opts)
       data
     end
 
-    # Get all monitor details.
+    # Get all monitors.
     #
-    # Get details about the specified monitor from your organization.
+    # Get all monitors from your organization.
     #
     # @param opts [Hash] the optional parameters
     # @option opts [String] :group_states When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`.
@@ -564,7 +564,7 @@ def list_monitors_with_http_info(opts = {})
       return data, status_code, headers
     end
 
-    # Get all monitor details.
+    # Get all monitors.
     #
     # Provide a paginated version of {#list_monitors}, returning all items.
     #

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.6",`
`7`		`- "regenerated": "2025-01-08 14:02:25.736805",`
`8`		`- "spec_repo_commit": "1920836f"`
	`7`	`+ "regenerated": "2025-01-09 22:06:06.242932",`
	`8`	`+ "spec_repo_commit": "8d40e082"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2025-01-08 14:02:25.752564",`
`13`		`- "spec_repo_commit": "1920836f"`
	`12`	`+ "regenerated": "2025-01-09 22:06:06.258111",`
	`13`	`+ "spec_repo_commit": "8d40e082"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Get all monitor details returns "OK" response`
	`1`	`+# Get all monitors returns "OK" response`
`2`	`2`
`3`	`3`	`require "datadog_api_client"`
`4`	`4`	`api_instance = DatadogAPIClient::V1::MonitorsAPI.new`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Get all monitor details with tags`
	`1`	`+# Get all monitors with tags`
`2`	`2`
`3`	`3`	`require "datadog_api_client"`
`4`	`4`	`api_instance = DatadogAPIClient::V1::MonitorsAPI.new`