Fix Get all monitor details documentation (#2851)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
DataDog · Jan 9, 2025 · 57e2119 · 57e2119
1 parent 79b10d9
commit 57e2119
Show file tree

Hide file tree

Showing 11 changed files with 16 additions and 15 deletions.
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:42.626158",
-            "spec_repo_commit": "07ed2f56"
+            "regenerated": "2025-01-09 21:08:20.268969",
+            "spec_repo_commit": "435429e0"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-09 20:03:42.641195",
-            "spec_repo_commit": "07ed2f56"
+            "regenerated": "2025-01-09 21:08:20.283894",
+            "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/api/datadogV1/api_monitors.go b/api/datadogV1/api_monitors.go
@@ -635,8 +635,8 @@ func (r *ListMonitorsOptionalParameters) WithPageSize(pageSize int32) *ListMonit
 	return r
 }
 
-// ListMonitors Get all monitor details.
-// Get details about the specified monitor from your organization.
+// ListMonitors Get all monitors.
+// Get all monitors from your organization.
 func (a *MonitorsApi) ListMonitors(ctx _context.Context, o ...ListMonitorsOptionalParameters) ([]Monitor, *_nethttp.Response, error) {
 	var (
 		localVarHTTPMethod  = _nethttp.MethodGet

diff --git a/examples/v1/monitors/ListMonitors.go b/examples/v1/monitors/ListMonitors.go
@@ -1,4 +1,4 @@
-// Get all monitor details returns "OK" response
+// Get all monitors returns "OK" response
 
 package main
 

diff --git a/...es/v1/monitors/ListMonitors_3448441939.go → ...es/v1/monitors/ListMonitors_2154432960.go b/...es/v1/monitors/ListMonitors_3448441939.go → ...es/v1/monitors/ListMonitors_2154432960.go
@@ -1,4 +1,4 @@
-// Get all monitor details with tags
+// Get all monitors with tags
 
 package main
 

diff --git a/...es/v1/monitors/ListMonitors_2966492814.go → ...les/v1/monitors/ListMonitors_463213563.go b/...es/v1/monitors/ListMonitors_2966492814.go → ...les/v1/monitors/ListMonitors_463213563.go
@@ -1,4 +1,4 @@
-// Get all monitor details returns "OK" response with pagination
+// Get all monitors returns "OK" response with pagination
 
 package main
 

diff --git a/...tails_returns_Bad_Request_response.freeze → ...itors_returns_Bad_Request_response.freeze b/...tails_returns_Bad_Request_response.freeze → ...itors_returns_Bad_Request_response.freeze
diff --git a/...details_returns_Bad_Request_response.yaml → ...onitors_returns_Bad_Request_response.yaml b/...details_returns_Bad_Request_response.yaml → ...onitors_returns_Bad_Request_response.yaml
diff --git a/...eturns_OK_response_with_pagination.freeze → ...eturns_OK_response_with_pagination.freeze b/...eturns_OK_response_with_pagination.freeze → ...eturns_OK_response_with_pagination.freeze
diff --git a/..._returns_OK_response_with_pagination.yaml → ..._returns_OK_response_with_pagination.yaml b/..._returns_OK_response_with_pagination.yaml → ..._returns_OK_response_with_pagination.yaml
diff --git a/tests/scenarios/features/v1/monitors.feature b/tests/scenarios/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 }}"