Fix Get all monitor details documentation (#1972)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 6a206c3f41cf · 2025-01-09T22:03:07.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-09 20:03:52.560198",
-            "spec_repo_commit": "07ed2f56"
+            "regenerated": "2025-01-09 21:08:21.064628",
+            "spec_repo_commit": "435429e0"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-09 20:03:52.575369",
-            "spec_repo_commit": "07ed2f56"
+            "regenerated": "2025-01-09 21:08:21.079610",
+            "spec_repo_commit": "435429e0"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.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:
diff --git a/cassettes/v1/Monitors_4022238206/Get-all-monitors-returns-Bad-Request-response_2086012425/frozen.json b/cassettes/v1/Monitors_4022238206/Get-all-monitors-returns-Bad-Request-response_2086012425/frozen.json
diff --git a/cassettes/v1/Monitors_4022238206/Get-all-monitors-returns-Bad-Request-response_2086012425/recording.har b/cassettes/v1/Monitors_4022238206/Get-all-monitors-returns-Bad-Request-response_2086012425/recording.har
@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Monitors/Get all monitor details returns \"Bad Request\" response",
+    "_recordingName": "Monitors/Get all monitors returns \"Bad Request\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",
diff --git a/cassettes/v1/Monitors_4022238206/Get-all-monitors-returns-OK-response-with-pagination_1138556425/frozen.json b/cassettes/v1/Monitors_4022238206/Get-all-monitors-returns-OK-response-with-pagination_1138556425/frozen.json
diff --git a/cassettes/v1/Monitors_4022238206/Get-all-monitors-returns-OK-response-with-pagination_1138556425/recording.har b/cassettes/v1/Monitors_4022238206/Get-all-monitors-returns-OK-response-with-pagination_1138556425/recording.har
@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Monitors/Get all monitor details returns \"OK\" response with pagination",
+    "_recordingName": "Monitors/Get all monitors returns \"OK\" response with pagination",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",
diff --git a/examples/v1/monitors/ListMonitors.ts b/examples/v1/monitors/ListMonitors.ts
@@ -1,5 +1,5 @@
 /**
- * Get all monitor details returns "OK" response
+ * Get all monitors returns "OK" response
  */
 
 import { client, v1 } from "@datadog/datadog-api-client";
diff --git a/examples/v1/monitors/ListMonitors_2154432960.ts b/examples/v1/monitors/ListMonitors_2154432960.ts
@@ -1,5 +1,5 @@
 /**
- * Get all monitor details with tags
+ * Get all monitors with tags
  */
 
 import { client, v1 } from "@datadog/datadog-api-client";
diff --git a/examples/v1/monitors/ListMonitors_463213563.ts b/examples/v1/monitors/ListMonitors_463213563.ts
@@ -1,5 +1,5 @@
 /**
- * Get all monitor details returns "OK" response with pagination
+ * Get all monitors returns "OK" response with pagination
  */
 
 import { client, v1 } from "@datadog/datadog-api-client";
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/packages/datadog-api-client-v1/apis/MonitorsApi.ts b/packages/datadog-api-client-v1/apis/MonitorsApi.ts
@@ -1668,7 +1668,7 @@ export class MonitorsApi {
   }
 
   /**
-   * Get details about the specified monitor from your organization.
+   * Get all monitors from your organization.
    * @param param The request object
    */
   public listMonitors(

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-09 20:03:52.560198",`
`8`		`- "spec_repo_commit": "07ed2f56"`
	`7`	`+ "regenerated": "2025-01-09 21:08:21.064628",`
	`8`	`+ "spec_repo_commit": "435429e0"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2025-01-09 20:03:52.575369",`
`13`		`- "spec_repo_commit": "07ed2f56"`
	`12`	`+ "regenerated": "2025-01-09 21:08:21.079610",`
	`13`	`+ "spec_repo_commit": "435429e0"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"log": {`
`3`		`- "_recordingName": "Monitors/Get all monitor details returns \"Bad Request\" response",`
	`3`	`+ "_recordingName": "Monitors/Get all monitors returns \"Bad Request\" response",`
`4`	`4`	`"creator": {`
`5`	`5`	`"comment": "persister:fs",`
`6`	`6`	`"name": "Polly.JS",`