From 723e7861bb1e3588b065812625fe9dca59e3f0b4 Mon Sep 17 00:00:00 2001 From: "api-clients-generation-pipeline[bot]" <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> Date: Thu, 9 Jan 2025 22:03:05 +0000 Subject: [PATCH] Fix `Get all monitor details` documentation (#2630) Co-authored-by: ci.datadog-api-spec --- .apigentools-info | 8 ++++---- .generator/schemas/v1/openapi.yaml | 5 +++-- examples/v1/monitors/ListMonitors.java | 2 +- ...8441939.java => ListMonitors_2154432960.java} | 2 +- ...66492814.java => ListMonitors_463213563.java} | 2 +- .../datadog/api/client/v1/api/MonitorsApi.java | 16 ++++++++-------- ...monitors_returns_Bad_Request_response.freeze} | 0 ...l_monitors_returns_Bad_Request_response.json} | 0 ...s_returns_OK_response_with_pagination.freeze} | 0 ...ors_returns_OK_response_with_pagination.json} | 0 .../datadog/api/client/v1/api/monitors.feature | 8 ++++---- 11 files changed, 22 insertions(+), 21 deletions(-) rename examples/v1/monitors/{ListMonitors_3448441939.java => ListMonitors_2154432960.java} (96%) rename examples/v1/monitors/{ListMonitors_2966492814.java => ListMonitors_463213563.java} (93%) rename src/test/resources/cassettes/features/v1/{Get_all_monitor_details_returns_Bad_Request_response.freeze => Get_all_monitors_returns_Bad_Request_response.freeze} (100%) rename src/test/resources/cassettes/features/v1/{Get_all_monitor_details_returns_Bad_Request_response.json => Get_all_monitors_returns_Bad_Request_response.json} (100%) rename src/test/resources/cassettes/features/v1/{Get_all_monitor_details_returns_OK_response_with_pagination.freeze => Get_all_monitors_returns_OK_response_with_pagination.freeze} (100%) rename src/test/resources/cassettes/features/v1/{Get_all_monitor_details_returns_OK_response_with_pagination.json => Get_all_monitors_returns_OK_response_with_pagination.json} (100%) diff --git a/.apigentools-info b/.apigentools-info index a003905dd0b..544980811bb 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2025-01-09 20:03:49.413256", - "spec_repo_commit": "07ed2f56" + "regenerated": "2025-01-09 21:08:21.521595", + "spec_repo_commit": "435429e0" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2025-01-09 20:03:49.430104", - "spec_repo_commit": "07ed2f56" + "regenerated": "2025-01-09 21:08:21.537040", + "spec_repo_commit": "435429e0" } } } \ No newline at end of file diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index e810c23508e..c2af523e94c 100644 --- 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/examples/v1/monitors/ListMonitors.java b/examples/v1/monitors/ListMonitors.java index 9397bf78444..f85f1ff982e 100644 --- a/examples/v1/monitors/ListMonitors.java +++ b/examples/v1/monitors/ListMonitors.java @@ -1,4 +1,4 @@ -// Get all monitor details returns "OK" response +// Get all monitors returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; diff --git a/examples/v1/monitors/ListMonitors_3448441939.java b/examples/v1/monitors/ListMonitors_2154432960.java similarity index 96% rename from examples/v1/monitors/ListMonitors_3448441939.java rename to examples/v1/monitors/ListMonitors_2154432960.java index 33af46fef29..c30b0531bed 100644 --- a/examples/v1/monitors/ListMonitors_3448441939.java +++ b/examples/v1/monitors/ListMonitors_2154432960.java @@ -1,4 +1,4 @@ -// Get all monitor details with tags +// Get all monitors with tags import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; diff --git a/examples/v1/monitors/ListMonitors_2966492814.java b/examples/v1/monitors/ListMonitors_463213563.java similarity index 93% rename from examples/v1/monitors/ListMonitors_2966492814.java rename to examples/v1/monitors/ListMonitors_463213563.java index c57b9e564e6..d3eaf9a222d 100644 --- a/examples/v1/monitors/ListMonitors_2966492814.java +++ b/examples/v1/monitors/ListMonitors_463213563.java @@ -1,4 +1,4 @@ -// Get all monitor details returns "OK" response with pagination +// Get all monitors returns "OK" response with pagination import com.datadog.api.client.ApiClient; import com.datadog.api.client.PaginationIterable; diff --git a/src/main/java/com/datadog/api/client/v1/api/MonitorsApi.java b/src/main/java/com/datadog/api/client/v1/api/MonitorsApi.java index 4219105929b..7cb0e92d1cf 100644 --- a/src/main/java/com/datadog/api/client/v1/api/MonitorsApi.java +++ b/src/main/java/com/datadog/api/client/v1/api/MonitorsApi.java @@ -1146,7 +1146,7 @@ public ListMonitorsOptionalParameters pageSize(Integer pageSize) { } /** - * Get all monitor details. + * Get all monitors. * *

See {@link #listMonitorsWithHttpInfo}. * @@ -1158,7 +1158,7 @@ public List listMonitors() throws ApiException { } /** - * Get all monitor details. + * Get all monitors. * *

See {@link #listMonitorsWithHttpInfoAsync}. * @@ -1173,7 +1173,7 @@ public CompletableFuture> listMonitorsAsync() { } /** - * Get all monitor details. + * Get all monitors. * *

See {@link #listMonitorsWithHttpInfo}. * @@ -1186,7 +1186,7 @@ public List listMonitors(ListMonitorsOptionalParameters parameters) thr } /** - * Get all monitor details. + * Get all monitors. * *

See {@link #listMonitorsWithHttpInfoAsync}. * @@ -1203,7 +1203,7 @@ public CompletableFuture> listMonitorsAsync( } /** - * Get all monitor details. + * Get all monitors. * *

See {@link #listMonitorsWithHttpInfo}. * @@ -1215,7 +1215,7 @@ public PaginationIterable listMonitorsWithPagination() { } /** - * Get all monitor details. + * Get all monitors. * *

See {@link #listMonitorsWithHttpInfo}. * @@ -1256,7 +1256,7 @@ public PaginationIterable listMonitorsWithPagination( } /** - * Get details about the specified monitor from your organization. + * Get all monitors from your organization. * * @param parameters Optional parameters for the request. * @return ApiResponse<List<Monitor>> @@ -1318,7 +1318,7 @@ public ApiResponse> listMonitorsWithHttpInfo( } /** - * Get all monitor details. + * Get all monitors. * *

See {@link #listMonitorsWithHttpInfo}. * diff --git a/src/test/resources/cassettes/features/v1/Get_all_monitor_details_returns_Bad_Request_response.freeze b/src/test/resources/cassettes/features/v1/Get_all_monitors_returns_Bad_Request_response.freeze similarity index 100% rename from src/test/resources/cassettes/features/v1/Get_all_monitor_details_returns_Bad_Request_response.freeze rename to src/test/resources/cassettes/features/v1/Get_all_monitors_returns_Bad_Request_response.freeze diff --git a/src/test/resources/cassettes/features/v1/Get_all_monitor_details_returns_Bad_Request_response.json b/src/test/resources/cassettes/features/v1/Get_all_monitors_returns_Bad_Request_response.json similarity index 100% rename from src/test/resources/cassettes/features/v1/Get_all_monitor_details_returns_Bad_Request_response.json rename to src/test/resources/cassettes/features/v1/Get_all_monitors_returns_Bad_Request_response.json diff --git a/src/test/resources/cassettes/features/v1/Get_all_monitor_details_returns_OK_response_with_pagination.freeze b/src/test/resources/cassettes/features/v1/Get_all_monitors_returns_OK_response_with_pagination.freeze similarity index 100% rename from src/test/resources/cassettes/features/v1/Get_all_monitor_details_returns_OK_response_with_pagination.freeze rename to src/test/resources/cassettes/features/v1/Get_all_monitors_returns_OK_response_with_pagination.freeze diff --git a/src/test/resources/cassettes/features/v1/Get_all_monitor_details_returns_OK_response_with_pagination.json b/src/test/resources/cassettes/features/v1/Get_all_monitors_returns_OK_response_with_pagination.json similarity index 100% rename from src/test/resources/cassettes/features/v1/Get_all_monitor_details_returns_OK_response_with_pagination.json rename to src/test/resources/cassettes/features/v1/Get_all_monitors_returns_OK_response_with_pagination.json diff --git a/src/test/resources/com/datadog/api/client/v1/api/monitors.feature b/src/test/resources/com/datadog/api/client/v1/api/monitors.feature index 5ff2e691c18..8154cd7a879 100644 --- a/src/test/resources/com/datadog/api/client/v1/api/monitors.feature +++ b/src/test/resources/com/datadog/api/client/v1/api/monitors.feature @@ -227,20 +227,20 @@ 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 @@ -248,7 +248,7 @@ Feature: Monitors 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 }}"