Skip to content

Commit

Permalink
Fix Get all monitor details documentation (#2630)
Browse files Browse the repository at this point in the history
Co-authored-by: ci.datadog-api-spec <[email protected]>
  • Loading branch information
api-clients-generation-pipeline[bot] and ci.datadog-api-spec authored Jan 9, 2025
1 parent 263c801 commit 723e786
Show file tree
Hide file tree
Showing 11 changed files with 22 additions and 21 deletions.
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
}
5 changes: 3 additions & 2 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -28956,6 +28956,7 @@ paths:
content:
application/json:
schema:
description: An array of monitor objects.
items:
$ref: '#/components/schemas/Monitor'
type: array
Expand All @@ -28979,7 +28980,7 @@ paths:
appKeyAuth: []
- AuthZ:
- monitors_read
summary: Get all monitor details
summary: Get all monitors
tags:
- Monitors
x-pagination:
Expand Down
2 changes: 1 addition & 1 deletion examples/v1/monitors/ListMonitors.java
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
16 changes: 8 additions & 8 deletions src/main/java/com/datadog/api/client/v1/api/MonitorsApi.java
Original file line number Diff line number Diff line change
Expand Up @@ -1146,7 +1146,7 @@ public ListMonitorsOptionalParameters pageSize(Integer pageSize) {
}

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

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

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

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

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

/**
* Get all monitor details.
* Get all monitors.
*
* <p>See {@link #listMonitorsWithHttpInfo}.
*
Expand Down Expand Up @@ -1256,7 +1256,7 @@ public PaginationIterable<Monitor> 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&lt;List&lt;Monitor&gt;&gt;
Expand Down Expand Up @@ -1318,7 +1318,7 @@ public ApiResponse<List<Monitor>> listMonitorsWithHttpInfo(
}

/**
* Get all monitor details.
* Get all monitors.
*
* <p>See {@link #listMonitorsWithHttpInfo}.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}"
Expand Down

0 comments on commit 723e786

Please sign in to comment.