feat(cockpit): add EnablePreconfiguredAlertRules endpoint (#2519)

Author: scaleway-bot

api/cockpit/v1/cockpit_sdk.go

@@ -518,6 +518,18 @@ func (enum *UsageUnit) UnmarshalJSON(data []byte) error {
 	return nil
 }
 
+// PreconfiguredAlertData: Structure for additional data relative to preconfigured alerts.
+type PreconfiguredAlertData struct {
+	// PreconfiguredRuleID: ID of the preconfigured rule if the alert is preconfigured.
+	PreconfiguredRuleID string `json:"preconfigured_rule_id"`
+
+	// DisplayName: human readable name of the alert.
+	DisplayName string `json:"display_name"`
+
+	// DisplayDescription: human readable description of the alert.
+	DisplayDescription string `json:"display_description"`
+}
+
 // ContactPointEmail: contact point email.
 type ContactPointEmail struct {
 	To string `json:"to"`
@@ -532,25 +544,35 @@ type GetConfigResponseRetention struct {
 	DefaultDays uint32 `json:"default_days"`
 }
 
-// Alert: alert.
+// Alert: Structure representing an alert.
 type Alert struct {
-	// Region: region to target. If none is passed will use default region from the config.
+	// Region: the region in which the alert is defined.
 	Region scw.Region `json:"region"`
 
+	// Preconfigured: indicates if the alert is preconfigured or custom.
 	Preconfigured bool `json:"preconfigured"`
 
+	// Name: name of the alert.
 	Name string `json:"name"`
 
+	// Rule: rule defining the alert condition.
 	Rule string `json:"rule"`
 
+	// Duration: duration for which the alert must be active before firing. The format of this duration follows the prometheus duration format.
 	Duration string `json:"duration"`
 
+	// Enabled: indicates if the alert is enabled or disabled. Only preconfigured alerts can be disabled.
 	Enabled bool `json:"enabled"`
 
-	// State: default value: unknown_state
+	// State: current state of the alert. Possible states are `inactive`, `pending`, and `firing`.
+	// Default value: unknown_state
 	State *AlertState `json:"state"`
 
+	// Annotations: annotations for the alert, used to provide additional information about the alert.
 	Annotations map[string]string `json:"annotations"`
+
+	// PreconfiguredData: contains additional data for preconfigured alerts, such as the rule ID, display name, and description. Only present if the alert is preconfigured.
+	PreconfiguredData *PreconfiguredAlertData `json:"preconfigured_data"`
 }
 
 // ContactPoint: Contact point.
@@ -1165,6 +1187,16 @@ type RegionalAPIDisableAlertManagerRequest struct {
 	ProjectID string `json:"project_id"`
 }
 
+// RegionalAPIDisableAlertRulesRequest: regional api disable alert rules request.
+type RegionalAPIDisableAlertRulesRequest struct {
+	// Region: region to target. If none is passed will use default region from the config.
+	Region scw.Region `json:"-"`
+
+	ProjectID string `json:"project_id"`
+
+	RuleIDs []string `json:"rule_ids"`
+}
+
 // RegionalAPIDisableManagedAlertsRequest: Disable the sending of managed alerts.
 type RegionalAPIDisableManagedAlertsRequest struct {
 	// Region: region to target. If none is passed will use default region from the config.
@@ -1183,6 +1215,16 @@ type RegionalAPIEnableAlertManagerRequest struct {
 	ProjectID string `json:"project_id"`
 }
 
+// RegionalAPIEnableAlertRulesRequest: regional api enable alert rules request.
+type RegionalAPIEnableAlertRulesRequest struct {
+	// Region: region to target. If none is passed will use default region from the config.
+	Region scw.Region `json:"-"`
+
+	ProjectID string `json:"project_id"`
+
+	RuleIDs []string `json:"rule_ids"`
+}
+
 // RegionalAPIEnableManagedAlertsRequest: Enable the sending of managed alerts.
 type RegionalAPIEnableManagedAlertsRequest struct {
 	// Region: region to target. If none is passed will use default region from the config.
@@ -1249,7 +1291,7 @@ type RegionalAPIListAlertsRequest struct {
 	// IsPreconfigured: true returns only preconfigured alerts. False returns only custom alerts. If omitted, no filtering is applied on alert types. Other filters may still apply.
 	IsPreconfigured *bool `json:"-"`
 
-	// State: valid values to filter on are `disabled`, `enabled`, `pending` and `firing`. If omitted, no filtering is applied on alert states. Other filters may still apply.
+	// 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.
 	// Default value: unknown_state
 	State *AlertState `json:"-"`
 }
@@ -2502,6 +2544,76 @@ func (s *RegionalAPI) DisableManagedAlerts(req *RegionalAPIDisableManagedAlertsR
 	return &resp, nil
 }
 
+// EnableAlertRules: Enable preconfigured alert rules. Enable alert rules from the list of available preconfigured rules.
+func (s *RegionalAPI) EnableAlertRules(req *RegionalAPIEnableAlertRulesRequest, opts ...scw.RequestOption) error {
+	var err error
+
+	if req.Region == "" {
+		defaultRegion, _ := s.client.GetDefaultRegion()
+		req.Region = defaultRegion
+	}
+
+	if req.ProjectID == "" {
+		defaultProjectID, _ := s.client.GetDefaultProjectID()
+		req.ProjectID = defaultProjectID
+	}
+
+	if fmt.Sprint(req.Region) == "" {
+		return errors.New("field Region cannot be empty in request")
+	}
+
+	scwReq := &scw.ScalewayRequest{
+		Method: "POST",
+		Path:   "/cockpit/v1/regions/" + fmt.Sprint(req.Region) + "/alert-manager/enable-alert-rules",
+	}
+
+	err = scwReq.SetBody(req)
+	if err != nil {
+		return err
+	}
+
+	err = s.client.Do(scwReq, nil, opts...)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+// DisableAlertRules: Disable preconfigured alert rules. Disable alert rules from the list of available preconfigured rules.
+func (s *RegionalAPI) DisableAlertRules(req *RegionalAPIDisableAlertRulesRequest, opts ...scw.RequestOption) error {
+	var err error
+
+	if req.Region == "" {
+		defaultRegion, _ := s.client.GetDefaultRegion()
+		req.Region = defaultRegion
+	}
+
+	if req.ProjectID == "" {
+		defaultProjectID, _ := s.client.GetDefaultProjectID()
+		req.ProjectID = defaultProjectID
+	}
+
+	if fmt.Sprint(req.Region) == "" {
+		return errors.New("field Region cannot be empty in request")
+	}
+
+	scwReq := &scw.ScalewayRequest{
+		Method: "POST",
+		Path:   "/cockpit/v1/regions/" + fmt.Sprint(req.Region) + "/alert-manager/disable-alert-rules",
+	}
+
+	err = scwReq.SetBody(req)
+	if err != nil {
+		return err
+	}
+
+	err = s.client.Do(scwReq, nil, opts...)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
 // TriggerTestAlert: Send a test alert to the Alert manager to make sure your contact points get notified.
 func (s *RegionalAPI) TriggerTestAlert(req *RegionalAPITriggerTestAlertRequest, opts ...scw.RequestOption) error {
 	var err error