Skip to content

Commit f8794d8

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Fix Get all monitor details documentation (#2331)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent da4d314 commit f8794d8

11 files changed

+17
-16
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-01-09 20:03:44.763258",
8-
"spec_repo_commit": "07ed2f56"
7+
"regenerated": "2025-01-09 21:08:24.162934",
8+
"spec_repo_commit": "435429e0"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-01-09 20:03:44.778099",
13-
"spec_repo_commit": "07ed2f56"
12+
"regenerated": "2025-01-09 21:08:24.177386",
13+
"spec_repo_commit": "435429e0"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28873,7 +28873,7 @@ paths:
2887328873
- metrics_metadata_write
2887428874
/api/v1/monitor:
2887528875
get:
28876-
description: Get details about the specified monitor from your organization.
28876+
description: Get all monitors from your organization.
2887728877
operationId: ListMonitors
2887828878
parameters:
2887928879
- description: 'When specified, shows additional information about the group
@@ -28956,6 +28956,7 @@ paths:
2895628956
content:
2895728957
application/json:
2895828958
schema:
28959+
description: An array of monitor objects.
2895928960
items:
2896028961
$ref: '#/components/schemas/Monitor'
2896128962
type: array
@@ -28979,7 +28980,7 @@ paths:
2897928980
appKeyAuth: []
2898028981
- AuthZ:
2898128982
- monitors_read
28982-
summary: Get all monitor details
28983+
summary: Get all monitors
2898328984
tags:
2898428985
- Monitors
2898528986
x-pagination:

examples/v1/monitors/ListMonitors.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Get all monitor details returns "OK" response
2+
Get all monitors returns "OK" response
33
"""
44

55
from datadog_api_client import ApiClient, Configuration

examples/v1/monitors/ListMonitors_3448441939.py renamed to examples/v1/monitors/ListMonitors_2154432960.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Get all monitor details with tags
2+
Get all monitors with tags
33
"""
44

55
from datadog_api_client import ApiClient, Configuration

examples/v1/monitors/ListMonitors_2966492814.py renamed to examples/v1/monitors/ListMonitors_463213563.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Get all monitor details returns "OK" response with pagination
2+
Get all monitors returns "OK" response with pagination
33
"""
44

55
from datadog_api_client import ApiClient, Configuration

src/datadog_api_client/v1/api/monitors_api.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -640,9 +640,9 @@ def list_monitors(
640640
page: Union[int, UnsetType] = unset,
641641
page_size: Union[int, UnsetType] = unset,
642642
) -> List[Monitor]:
643-
"""Get all monitor details.
643+
"""Get all monitors.
644644
645-
Get details about the specified monitor from your organization.
645+
Get all monitors from your organization.
646646
647647
:param group_states: When specified, shows additional information about the group states.
648648
Choose one or more from ``all`` , ``alert`` , ``warn`` , and ``no data``.
@@ -704,7 +704,7 @@ def list_monitors_with_pagination(
704704
page: Union[int, UnsetType] = unset,
705705
page_size: Union[int, UnsetType] = unset,
706706
) -> collections.abc.Iterable[Monitor]:
707-
"""Get all monitor details.
707+
"""Get all monitors.
708708
709709
Provide a paginated version of :meth:`list_monitors`, returning all items.
710710

0 commit comments

Comments
 (0)