Skip to content

docs(cockpit): deprecate managed alerts routes #1312

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

Merged
merged 2 commits into from
Oct 17, 2025
Merged

docs(cockpit): deprecate managed alerts routes #1312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa6cc2a
feat: update generated APIs
scaleway-bot Oct 17, 2025
19ad60d
Merge branch 'main' into v1.7155.0
jremy42 Oct 17, 2025
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
4 changes: 0 additions & 4 deletions scaleway-async/scaleway_async/cockpit/v1/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,8 @@
from .types import RegionalApiDeleteTokenRequest
from .types import RegionalApiDisableAlertManagerRequest
from .types import RegionalApiDisableAlertRulesRequest
from .types import RegionalApiDisableManagedAlertsRequest
from .types import RegionalApiEnableAlertManagerRequest
from .types import RegionalApiEnableAlertRulesRequest
from .types import RegionalApiEnableManagedAlertsRequest
from .types import RegionalApiGetAlertManagerRequest
from .types import RegionalApiGetConfigRequest
from .types import RegionalApiGetDataSourceRequest
Expand Down Expand Up @@ -134,10 +132,8 @@
"RegionalApiDeleteTokenRequest",
"RegionalApiDisableAlertManagerRequest",
"RegionalApiDisableAlertRulesRequest",
"RegionalApiDisableManagedAlertsRequest",
"RegionalApiEnableAlertManagerRequest",
"RegionalApiEnableAlertRulesRequest",
"RegionalApiEnableManagedAlertsRequest",
"RegionalApiGetAlertManagerRequest",
"RegionalApiGetConfigRequest",
"RegionalApiGetDataSourceRequest",
Expand Down
82 changes: 1 addition & 81 deletions scaleway-async/scaleway_async/cockpit/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,8 @@
RegionalApiDeleteContactPointRequest,
RegionalApiDisableAlertManagerRequest,
RegionalApiDisableAlertRulesRequest,
RegionalApiDisableManagedAlertsRequest,
RegionalApiEnableAlertManagerRequest,
RegionalApiEnableAlertRulesRequest,
RegionalApiEnableManagedAlertsRequest,
RegionalApiTriggerTestAlertRequest,
RegionalApiUpdateContactPointRequest,
RegionalApiUpdateDataSourceRequest,
Expand Down Expand Up @@ -93,10 +91,8 @@
marshal_RegionalApiDeleteContactPointRequest,
marshal_RegionalApiDisableAlertManagerRequest,
marshal_RegionalApiDisableAlertRulesRequest,
marshal_RegionalApiDisableManagedAlertsRequest,
marshal_RegionalApiEnableAlertManagerRequest,
marshal_RegionalApiEnableAlertRulesRequest,
marshal_RegionalApiEnableManagedAlertsRequest,
marshal_RegionalApiTriggerTestAlertRequest,
marshal_RegionalApiUpdateContactPointRequest,
marshal_RegionalApiUpdateDataSourceRequest,
Expand Down Expand Up @@ -1238,7 +1234,7 @@ async def get_rules_count(
project_id: Optional[str] = None,
) -> GetRulesCountResponse:
"""
Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.
Get the number of enabled rules Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: ID of the Project to retrieve the rule count for.
:return: :class:`GetRulesCountResponse <GetRulesCountResponse>`
Expand Down Expand Up @@ -1515,82 +1511,6 @@ async def list_alerts(
self._throw_on_error(res)
return unmarshal_ListAlertsResponse(res.json())

async def enable_managed_alerts(
self,
*,
region: Optional[ScwRegion] = None,
project_id: Optional[str] = None,
) -> AlertManager:
"""
Enable managed alerts.
Enable the sending of managed alerts for the specified Project. Managed alerts are predefined alerts that apply to Scaleway recources integrated with Cockpit by default.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: ID of the Project.
:return: :class:`AlertManager <AlertManager>`

Usage:
::

result = await api.enable_managed_alerts()
"""

param_region = validate_path_param(
"region", region or self.client.default_region
)

res = self._request(
"POST",
f"/cockpit/v1/regions/{param_region}/alert-manager/managed-alerts/enable",
body=marshal_RegionalApiEnableManagedAlertsRequest(
RegionalApiEnableManagedAlertsRequest(
region=region,
project_id=project_id,
),
self.client,
),
)

self._throw_on_error(res)
return unmarshal_AlertManager(res.json())

async def disable_managed_alerts(
self,
*,
region: Optional[ScwRegion] = None,
project_id: Optional[str] = None,
) -> AlertManager:
"""
Disable managed alerts.
Disable the sending of managed alerts for the specified Project.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: ID of the Project.
:return: :class:`AlertManager <AlertManager>`

Usage:
::

result = await api.disable_managed_alerts()
"""

param_region = validate_path_param(
"region", region or self.client.default_region
)

res = self._request(
"POST",
f"/cockpit/v1/regions/{param_region}/alert-manager/managed-alerts/disable",
body=marshal_RegionalApiDisableManagedAlertsRequest(
RegionalApiDisableManagedAlertsRequest(
region=region,
project_id=project_id,
),
self.client,
),
)

self._throw_on_error(res)
return unmarshal_AlertManager(res.json())

async def enable_alert_rules(
self,
*,
Expand Down
30 changes: 0 additions & 30 deletions scaleway-async/scaleway_async/cockpit/v1/marshalling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,8 @@
RegionalApiDeleteContactPointRequest,
RegionalApiDisableAlertManagerRequest,
RegionalApiDisableAlertRulesRequest,
RegionalApiDisableManagedAlertsRequest,
RegionalApiEnableAlertManagerRequest,
RegionalApiEnableAlertRulesRequest,
RegionalApiEnableManagedAlertsRequest,
RegionalApiTriggerTestAlertRequest,
RegionalApiUpdateContactPointRequest,
RegionalApiUpdateDataSourceRequest,
Expand Down Expand Up @@ -1204,20 +1202,6 @@ def marshal_RegionalApiDisableAlertRulesRequest(
return output


def marshal_RegionalApiDisableManagedAlertsRequest(
request: RegionalApiDisableManagedAlertsRequest,
defaults: ProfileDefaults,
) -> dict[str, Any]:
output: dict[str, Any] = {}

if request.project_id is not None:
output["project_id"] = request.project_id
else:
output["project_id"] = defaults.default_project_id

return output


def marshal_RegionalApiEnableAlertManagerRequest(
request: RegionalApiEnableAlertManagerRequest,
defaults: ProfileDefaults,
Expand Down Expand Up @@ -1249,20 +1233,6 @@ def marshal_RegionalApiEnableAlertRulesRequest(
return output


def marshal_RegionalApiEnableManagedAlertsRequest(
request: RegionalApiEnableManagedAlertsRequest,
defaults: ProfileDefaults,
) -> dict[str, Any]:
output: dict[str, Any] = {}

if request.project_id is not None:
output["project_id"] = request.project_id
else:
output["project_id"] = defaults.default_project_id

return output


def marshal_RegionalApiTriggerTestAlertRequest(
request: RegionalApiTriggerTestAlertRequest,
defaults: ProfileDefaults,
Expand Down
34 changes: 0 additions & 34 deletions scaleway-async/scaleway_async/cockpit/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1152,23 +1152,6 @@ class RegionalApiDisableAlertRulesRequest:
"""


@dataclass
class RegionalApiDisableManagedAlertsRequest:
"""
Disable the sending of managed alerts.
"""

region: Optional[ScwRegion] = None
"""
Region to target. If none is passed will use default region from the config.
"""

project_id: Optional[str] = None
"""
ID of the Project.
"""


@dataclass
class RegionalApiEnableAlertManagerRequest:
"""
Expand Down Expand Up @@ -1204,23 +1187,6 @@ class RegionalApiEnableAlertRulesRequest:
"""


@dataclass
class RegionalApiEnableManagedAlertsRequest:
"""
Enable the sending of managed alerts.
"""

region: Optional[ScwRegion] = None
"""
Region to target. If none is passed will use default region from the config.
"""

project_id: Optional[str] = None
"""
ID of the Project.
"""


@dataclass
class RegionalApiGetAlertManagerRequest:
"""
Expand Down
4 changes: 0 additions & 4 deletions scaleway/scaleway/cockpit/v1/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,8 @@
from .types import RegionalApiDeleteTokenRequest
from .types import RegionalApiDisableAlertManagerRequest
from .types import RegionalApiDisableAlertRulesRequest
from .types import RegionalApiDisableManagedAlertsRequest
from .types import RegionalApiEnableAlertManagerRequest
from .types import RegionalApiEnableAlertRulesRequest
from .types import RegionalApiEnableManagedAlertsRequest
from .types import RegionalApiGetAlertManagerRequest
from .types import RegionalApiGetConfigRequest
from .types import RegionalApiGetDataSourceRequest
Expand Down Expand Up @@ -134,10 +132,8 @@
"RegionalApiDeleteTokenRequest",
"RegionalApiDisableAlertManagerRequest",
"RegionalApiDisableAlertRulesRequest",
"RegionalApiDisableManagedAlertsRequest",
"RegionalApiEnableAlertManagerRequest",
"RegionalApiEnableAlertRulesRequest",
"RegionalApiEnableManagedAlertsRequest",
"RegionalApiGetAlertManagerRequest",
"RegionalApiGetConfigRequest",
"RegionalApiGetDataSourceRequest",
Expand Down
82 changes: 1 addition & 81 deletions scaleway/scaleway/cockpit/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,8 @@
RegionalApiDeleteContactPointRequest,
RegionalApiDisableAlertManagerRequest,
RegionalApiDisableAlertRulesRequest,
RegionalApiDisableManagedAlertsRequest,
RegionalApiEnableAlertManagerRequest,
RegionalApiEnableAlertRulesRequest,
RegionalApiEnableManagedAlertsRequest,
RegionalApiTriggerTestAlertRequest,
RegionalApiUpdateContactPointRequest,
RegionalApiUpdateDataSourceRequest,
Expand Down Expand Up @@ -93,10 +91,8 @@
marshal_RegionalApiDeleteContactPointRequest,
marshal_RegionalApiDisableAlertManagerRequest,
marshal_RegionalApiDisableAlertRulesRequest,
marshal_RegionalApiDisableManagedAlertsRequest,
marshal_RegionalApiEnableAlertManagerRequest,
marshal_RegionalApiEnableAlertRulesRequest,
marshal_RegionalApiEnableManagedAlertsRequest,
marshal_RegionalApiTriggerTestAlertRequest,
marshal_RegionalApiUpdateContactPointRequest,
marshal_RegionalApiUpdateDataSourceRequest,
Expand Down Expand Up @@ -1238,7 +1234,7 @@ def get_rules_count(
project_id: Optional[str] = None,
) -> GetRulesCountResponse:
"""
Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.
Get the number of enabled rules Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: ID of the Project to retrieve the rule count for.
:return: :class:`GetRulesCountResponse <GetRulesCountResponse>`
Expand Down Expand Up @@ -1515,82 +1511,6 @@ def list_alerts(
self._throw_on_error(res)
return unmarshal_ListAlertsResponse(res.json())

def enable_managed_alerts(
self,
*,
region: Optional[ScwRegion] = None,
project_id: Optional[str] = None,
) -> AlertManager:
"""
Enable managed alerts.
Enable the sending of managed alerts for the specified Project. Managed alerts are predefined alerts that apply to Scaleway recources integrated with Cockpit by default.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: ID of the Project.
:return: :class:`AlertManager <AlertManager>`

Usage:
::

result = api.enable_managed_alerts()
"""

param_region = validate_path_param(
"region", region or self.client.default_region
)

res = self._request(
"POST",
f"/cockpit/v1/regions/{param_region}/alert-manager/managed-alerts/enable",
body=marshal_RegionalApiEnableManagedAlertsRequest(
RegionalApiEnableManagedAlertsRequest(
region=region,
project_id=project_id,
),
self.client,
),
)

self._throw_on_error(res)
return unmarshal_AlertManager(res.json())

def disable_managed_alerts(
self,
*,
region: Optional[ScwRegion] = None,
project_id: Optional[str] = None,
) -> AlertManager:
"""
Disable managed alerts.
Disable the sending of managed alerts for the specified Project.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: ID of the Project.
:return: :class:`AlertManager <AlertManager>`

Usage:
::

result = api.disable_managed_alerts()
"""

param_region = validate_path_param(
"region", region or self.client.default_region
)

res = self._request(
"POST",
f"/cockpit/v1/regions/{param_region}/alert-manager/managed-alerts/disable",
body=marshal_RegionalApiDisableManagedAlertsRequest(
RegionalApiDisableManagedAlertsRequest(
region=region,
project_id=project_id,
),
self.client,
),
)

self._throw_on_error(res)
return unmarshal_AlertManager(res.json())

def enable_alert_rules(
self,
*,
Expand Down
Loading