Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Get all monitor details documentation #2851

Merged
merged 1 commit into from
Jan 9, 2025
Merged

Fix Get all monitor details documentation #2851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
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: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"
}
}
}
5 changes: 3 additions & 2 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
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
4 changes: 2 additions & 2 deletions api/datadogV1/api_monitors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/v1/monitors/ListMonitors.go
View file
Open in desktop
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

package main

Expand Down
2 changes: 1 addition & 1 deletion ...es/v1/monitors/ListMonitors_3448441939.go → ...es/v1/monitors/ListMonitors_2154432960.go
View file
Open in desktop
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

package main

Expand Down
2 changes: 1 addition & 1 deletion ...es/v1/monitors/ListMonitors_2966492814.go → ...les/v1/monitors/ListMonitors_463213563.go
View file
Open in desktop
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

package main

Expand Down
0 ...tails_returns_Bad_Request_response.freeze → ...itors_returns_Bad_Request_response.freeze
View file
Open in desktop
File renamed without changes.
0 ...details_returns_Bad_Request_response.yaml → ...onitors_returns_Bad_Request_response.yaml
View file
Open in desktop
File renamed without changes.
0 ...eturns_OK_response_with_pagination.freeze → ...eturns_OK_response_with_pagination.freeze
View file
Open in desktop
File renamed without changes.
0 ..._returns_OK_response_with_pagination.yaml → ..._returns_OK_response_with_pagination.yaml
View file
Open in desktop
File renamed without changes.
8 changes: 4 additions & 4 deletions tests/scenarios/features/v1/monitors.feature
View file
Open in desktop
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
Loading