Skip to content

Commit f138405

Browse files
docs(cockpit): deprecate managed alerts routes (#2506)
Co-authored-by: Jonathan R. <jremy@scaleway.com>
1 parent b526f49 commit f138405

File tree

4 files changed

+1
-99
lines changed

4 files changed

+1
-99
lines changed

packages_generated/cockpit/src/v1/api.gen.ts

Lines changed: 1 addition & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,8 @@ import {
2020
marshalRegionalApiDeleteContactPointRequest,
2121
marshalRegionalApiDisableAlertManagerRequest,
2222
marshalRegionalApiDisableAlertRulesRequest,
23-
marshalRegionalApiDisableManagedAlertsRequest,
2423
marshalRegionalApiEnableAlertManagerRequest,
2524
marshalRegionalApiEnableAlertRulesRequest,
26-
marshalRegionalApiEnableManagedAlertsRequest,
2725
marshalRegionalApiTriggerTestAlertRequest,
2826
marshalRegionalApiUpdateContactPointRequest,
2927
marshalRegionalApiUpdateDataSourceRequest,
@@ -86,10 +84,8 @@ import type {
8684
RegionalApiDeleteTokenRequest,
8785
RegionalApiDisableAlertManagerRequest,
8886
RegionalApiDisableAlertRulesRequest,
89-
RegionalApiDisableManagedAlertsRequest,
9087
RegionalApiEnableAlertManagerRequest,
9188
RegionalApiEnableAlertRulesRequest,
92-
RegionalApiEnableManagedAlertsRequest,
9389
RegionalApiGetAlertManagerRequest,
9490
RegionalApiGetConfigRequest,
9591
RegionalApiGetDataSourceRequest,
@@ -695,7 +691,7 @@ The output returned displays a URL to access the Alert manager, and whether the
695691
)
696692

697693
/**
698-
* Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.. Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.
694+
* 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.. 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.
699695
*
700696
* @param request - The request {@link RegionalApiGetRulesCountRequest}
701697
* @returns A Promise of GetRulesCountResponse
@@ -835,54 +831,6 @@ If you need to receive alerts for other receivers, you can create additional con
835831
unmarshalListAlertsResponse,
836832
)
837833

838-
/**
839-
* 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.
840-
*
841-
* @param request - The request {@link RegionalApiEnableManagedAlertsRequest}
842-
* @returns A Promise of AlertManager
843-
*/
844-
enableManagedAlerts = (
845-
request: Readonly<RegionalApiEnableManagedAlertsRequest> = {},
846-
) =>
847-
this.client.fetch<AlertManager>(
848-
{
849-
body: JSON.stringify(
850-
marshalRegionalApiEnableManagedAlertsRequest(
851-
request,
852-
this.client.settings,
853-
),
854-
),
855-
headers: jsonContentHeaders,
856-
method: 'POST',
857-
path: `/cockpit/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/alert-manager/managed-alerts/enable`,
858-
},
859-
unmarshalAlertManager,
860-
)
861-
862-
/**
863-
* Disable managed alerts. Disable the sending of managed alerts for the specified Project.
864-
*
865-
* @param request - The request {@link RegionalApiDisableManagedAlertsRequest}
866-
* @returns A Promise of AlertManager
867-
*/
868-
disableManagedAlerts = (
869-
request: Readonly<RegionalApiDisableManagedAlertsRequest> = {},
870-
) =>
871-
this.client.fetch<AlertManager>(
872-
{
873-
body: JSON.stringify(
874-
marshalRegionalApiDisableManagedAlertsRequest(
875-
request,
876-
this.client.settings,
877-
),
878-
),
879-
headers: jsonContentHeaders,
880-
method: 'POST',
881-
path: `/cockpit/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/alert-manager/managed-alerts/disable`,
882-
},
883-
unmarshalAlertManager,
884-
)
885-
886834
/**
887835
* Enable preconfigured alert rules. Enable alert rules from the list of available preconfigured rules.
888836
*

packages_generated/cockpit/src/v1/index.gen.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,8 @@ export type {
5757
RegionalApiDeleteTokenRequest,
5858
RegionalApiDisableAlertManagerRequest,
5959
RegionalApiDisableAlertRulesRequest,
60-
RegionalApiDisableManagedAlertsRequest,
6160
RegionalApiEnableAlertManagerRequest,
6261
RegionalApiEnableAlertRulesRequest,
63-
RegionalApiEnableManagedAlertsRequest,
6462
RegionalApiGetAlertManagerRequest,
6563
RegionalApiGetConfigRequest,
6664
RegionalApiGetDataSourceRequest,

packages_generated/cockpit/src/v1/marshalling.gen.ts

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,8 @@ import type {
4141
RegionalApiDeleteContactPointRequest,
4242
RegionalApiDisableAlertManagerRequest,
4343
RegionalApiDisableAlertRulesRequest,
44-
RegionalApiDisableManagedAlertsRequest,
4544
RegionalApiEnableAlertManagerRequest,
4645
RegionalApiEnableAlertRulesRequest,
47-
RegionalApiEnableManagedAlertsRequest,
4846
RegionalApiTriggerTestAlertRequest,
4947
RegionalApiUpdateContactPointRequest,
5048
RegionalApiUpdateDataSourceRequest,
@@ -613,13 +611,6 @@ export const marshalRegionalApiDisableAlertRulesRequest = (
613611
rule_ids: request.ruleIds,
614612
})
615613

616-
export const marshalRegionalApiDisableManagedAlertsRequest = (
617-
request: RegionalApiDisableManagedAlertsRequest,
618-
defaults: DefaultValues,
619-
): Record<string, unknown> => ({
620-
project_id: request.projectId ?? defaults.defaultProjectId,
621-
})
622-
623614
export const marshalRegionalApiEnableAlertManagerRequest = (
624615
request: RegionalApiEnableAlertManagerRequest,
625616
defaults: DefaultValues,
@@ -635,13 +626,6 @@ export const marshalRegionalApiEnableAlertRulesRequest = (
635626
rule_ids: request.ruleIds,
636627
})
637628

638-
export const marshalRegionalApiEnableManagedAlertsRequest = (
639-
request: RegionalApiEnableManagedAlertsRequest,
640-
defaults: DefaultValues,
641-
): Record<string, unknown> => ({
642-
project_id: request.projectId ?? defaults.defaultProjectId,
643-
})
644-
645629
export const marshalRegionalApiTriggerTestAlertRequest = (
646630
request: RegionalApiTriggerTestAlertRequest,
647631
defaults: DefaultValues,

packages_generated/cockpit/src/v1/types.gen.ts

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -895,20 +895,6 @@ export type RegionalApiDisableAlertRulesRequest = {
895895
ruleIds?: string[]
896896
}
897897

898-
/**
899-
* Disable the sending of managed alerts.
900-
*/
901-
export type RegionalApiDisableManagedAlertsRequest = {
902-
/**
903-
* Region to target. If none is passed will use default region from the config.
904-
*/
905-
region?: ScwRegion
906-
/**
907-
* ID of the Project.
908-
*/
909-
projectId?: string
910-
}
911-
912898
/**
913899
* Enable the Alert manager.
914900
*/
@@ -938,20 +924,6 @@ export type RegionalApiEnableAlertRulesRequest = {
938924
ruleIds?: string[]
939925
}
940926

941-
/**
942-
* Enable the sending of managed alerts.
943-
*/
944-
export type RegionalApiEnableManagedAlertsRequest = {
945-
/**
946-
* Region to target. If none is passed will use default region from the config.
947-
*/
948-
region?: ScwRegion
949-
/**
950-
* ID of the Project.
951-
*/
952-
projectId?: string
953-
}
954-
955927
/**
956928
* Get the Alert manager.
957929
*/

0 commit comments

Comments
 (0)