Skip to content

Commit 152708c

Browse files
authored
docs(cockpit): add small precisions in documentation (#1001)
1 parent d1b4d48 commit 152708c

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

scaleway-async/scaleway_async/cockpit/v1/api.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1450,13 +1450,13 @@ async def list_alerts(
14501450
) -> ListAlertsResponse:
14511451
"""
14521452
List alerts.
1453-
List preconfigured and/or custom alerts for the specified Project.
1453+
List preconfigured and/or custom alerts for the specified Project and data source.
14541454
:param region: Region to target. If none is passed will use default region from the config.
14551455
:param project_id: Project ID to filter for, only alerts from this Project will be returned.
14561456
:param is_enabled: True returns only enabled alerts. False returns only disabled alerts. If omitted, no alert filtering is applied. Other filters may still apply.
14571457
:param is_preconfigured: True returns only preconfigured alerts. False returns only custom alerts. If omitted, no filtering is applied on alert types. Other filters may still apply.
14581458
:param state: Valid values to filter on are `inactive`, `pending` and `firing`. If omitted, no filtering is applied on alert states. Other filters may still apply.
1459-
:param data_source_id: If omitted, only alerts from the default scaleway data source will be listed.
1459+
:param data_source_id: If omitted, only alerts from the default Scaleway metrics data source will be listed.
14601460
:return: :class:`ListAlertsResponse <ListAlertsResponse>`
14611461
14621462
Usage:

scaleway-async/scaleway_async/cockpit/v1/types.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1256,7 +1256,7 @@ class RegionalApiListAlertsRequest:
12561256

12571257
data_source_id: Optional[str]
12581258
"""
1259-
If omitted, only alerts from the default scaleway data source will be listed.
1259+
If omitted, only alerts from the default Scaleway metrics data source will be listed.
12601260
"""
12611261

12621262

scaleway/scaleway/cockpit/v1/api.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1450,13 +1450,13 @@ def list_alerts(
14501450
) -> ListAlertsResponse:
14511451
"""
14521452
List alerts.
1453-
List preconfigured and/or custom alerts for the specified Project.
1453+
List preconfigured and/or custom alerts for the specified Project and data source.
14541454
:param region: Region to target. If none is passed will use default region from the config.
14551455
:param project_id: Project ID to filter for, only alerts from this Project will be returned.
14561456
:param is_enabled: True returns only enabled alerts. False returns only disabled alerts. If omitted, no alert filtering is applied. Other filters may still apply.
14571457
:param is_preconfigured: True returns only preconfigured alerts. False returns only custom alerts. If omitted, no filtering is applied on alert types. Other filters may still apply.
14581458
:param state: Valid values to filter on are `inactive`, `pending` and `firing`. If omitted, no filtering is applied on alert states. Other filters may still apply.
1459-
:param data_source_id: If omitted, only alerts from the default scaleway data source will be listed.
1459+
:param data_source_id: If omitted, only alerts from the default Scaleway metrics data source will be listed.
14601460
:return: :class:`ListAlertsResponse <ListAlertsResponse>`
14611461
14621462
Usage:

scaleway/scaleway/cockpit/v1/types.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1256,7 +1256,7 @@ class RegionalApiListAlertsRequest:
12561256

12571257
data_source_id: Optional[str]
12581258
"""
1259-
If omitted, only alerts from the default scaleway data source will be listed.
1259+
If omitted, only alerts from the default Scaleway metrics data source will be listed.
12601260
"""
12611261

12621262

0 commit comments

Comments
 (0)