Fix Get all monitor details documentation (#2331)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-09 20:03:44.763258",
-            "spec_repo_commit": "07ed2f56"
+            "regenerated": "2025-01-09 21:08:24.162934",
+            "spec_repo_commit": "435429e0"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-09 20:03:44.778099",
-            "spec_repo_commit": "07ed2f56"
+            "regenerated": "2025-01-09 21:08:24.177386",
+            "spec_repo_commit": "435429e0"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -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:

examples/v1/monitors/ListMonitors.py

@@ -1,5 +1,5 @@
 """
-Get all monitor details returns "OK" response
+Get all monitors returns "OK" response
 """
 
 from datadog_api_client import ApiClient, Configuration

examples/v1/monitors/ListMonitors_3448441939.py renamed to examples/v1/monitors/ListMonitors_2154432960.py

@@ -1,5 +1,5 @@
 """
-Get all monitor details with tags
+Get all monitors with tags
 """
 
 from datadog_api_client import ApiClient, Configuration

examples/v1/monitors/ListMonitors_2966492814.py renamed to examples/v1/monitors/ListMonitors_463213563.py

@@ -1,5 +1,5 @@
 """
-Get all monitor details returns "OK" response with pagination
+Get all monitors returns "OK" response with pagination
 """
 
 from datadog_api_client import ApiClient, Configuration

src/datadog_api_client/v1/api/monitors_api.py

@@ -640,9 +640,9 @@ def list_monitors(
         page: Union[int, UnsetType] = unset,
         page_size: Union[int, UnsetType] = unset,
     ) -> List[Monitor]:
-        """Get all monitor details.
+        """Get all monitors.
 
-        Get details about the specified monitor from your organization.
+        Get all monitors from your organization.
 
         :param group_states: When specified, shows additional information about the group states.
             Choose one or more from ``all`` , ``alert`` , ``warn`` , and ``no data``.
@@ -704,7 +704,7 @@ def list_monitors_with_pagination(
         page: Union[int, UnsetType] = unset,
         page_size: Union[int, UnsetType] = unset,
     ) -> collections.abc.Iterable[Monitor]:
-        """Get all monitor details.
+        """Get all monitors.
 
         Provide a paginated version of :meth:`list_monitors`, returning all items.
 

tests/v1/cassettes/test_scenarios/test_get_all_monitor_details_returns_bad_request_response.frozen renamed to tests/v1/cassettes/test_scenarios/test_get_all_monitors_returns_bad_request_response.frozen

@@ -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 }}"