Add slo_query to SLO Correction API for global correction support (#1711)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v1/openapi.yaml

@@ -13177,13 +13177,16 @@ components:
       type: object
     SLOCorrectionCreateRequest:
       description: |-
-        An object that defines a correction to be applied to an SLO.
+        An object that defines a correction to be applied to one or more SLOs.
       properties:
         data:
           $ref: "#/components/schemas/SLOCorrectionCreateData"
       type: object
     SLOCorrectionCreateRequestAttributes:
-      description: The attribute object associated with the SLO correction to be created.
+      description: |-
+        The attribute object associated with the SLO correction to be created.
+
+        Exactly one of `slo_id` or `slo_query` must be provided.
       properties:
         category:
           $ref: "#/components/schemas/SLOCorrectionCategory"
@@ -13207,9 +13210,16 @@ components:
           example: FREQ=DAILY;INTERVAL=10;COUNT=5
           type: string
         slo_id:
-          description: ID of the SLO that this correction applies to.
+          description: ID of the single SLO that this correction applies to.
           example: sloId
           type: string
+        slo_query:
+          description: |-
+            Query that matches the SLOs this correction applies to.
+            The query uses the [Events search syntax](https://docs.datadoghq.com/events/explorer/searching/)
+            and can filter SLOs by SLO tags.
+          example: "env:prod service:checkout"
+          type: string
         start:
           description: Starting time of the correction in epoch seconds.
           example: 1600000000
@@ -13220,7 +13230,6 @@ components:
           example: UTC
           type: string
       required:
-        - slo_id
         - start
         - category
       type: object
@@ -13284,7 +13293,12 @@ components:
           nullable: true
           type: string
         slo_id:
-          description: ID of the SLO that this correction applies to.
+          description: ID of the single SLO that this correction applies to.
+          nullable: true
+          type: string
+        slo_query:
+          description: Query that matches the SLOs this correction applies to.
+          nullable: true
           type: string
         start:
           description: Starting time of the correction in epoch seconds.
@@ -13356,6 +13370,13 @@ components:
             are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`.
           example: FREQ=DAILY;INTERVAL=10;COUNT=5
           type: string
+        slo_query:
+          description: |-
+            Query that matches the SLOs this correction applies to.
+            The query uses the [Events search syntax](https://docs.datadoghq.com/events/explorer/searching/)
+            and can filter SLOs by SLO tags.
+          example: "env:prod service:checkout"
+          type: string
         start:
           description: Starting time of the correction in epoch seconds.
           example: 1600000000
@@ -37493,7 +37514,8 @@ paths:
           - slos_read
     post:
       description: |-
-        Create an SLO Correction.
+        Create an SLO correction. Use `slo_id` to apply the correction to a single SLO, or `slo_query` to apply the
+        correction to SLOs that match a query. Exactly one of `slo_id` or `slo_query` is required.
       operationId: CreateSLOCorrection
       requestBody:
         content:
@@ -37510,6 +37532,17 @@ paths:
                       start: 1600000000
                       timezone: UTC
                     type: correction
+              slo_query:
+                value:
+                  data:
+                    attributes:
+                      category: "Scheduled Maintenance"
+                      description: "Planned maintenance window for checkout services."
+                      end: 1600003600
+                      slo_query: "env:prod service:checkout"
+                      start: 1600000000
+                      timezone: UTC
+                    type: correction
             schema:
               $ref: "#/components/schemas/SLOCorrectionCreateRequest"
         description: Create an SLO Correction
@@ -37669,6 +37702,17 @@ paths:
                       start: 1600000000
                       timezone: UTC
                     type: correction
+              slo_query:
+                value:
+                  data:
+                    attributes:
+                      category: "Scheduled Maintenance"
+                      description: "Updated correction for checkout services."
+                      end: 1600003600
+                      slo_query: "env:prod service:checkout"
+                      start: 1600000000
+                      timezone: UTC
+                    type: correction
             schema:
               $ref: "#/components/schemas/SLOCorrectionUpdateRequest"
         description: The edited SLO correction object.

examples/v1_service-level-objective-corrections_CreateSLOCorrection.rs

@@ -15,11 +15,11 @@ async fn main() {
         SLOCorrectionCreateData::new(SLOCorrectionType::CORRECTION).attributes(
             SLOCorrectionCreateRequestAttributes::new(
                 SLOCorrectionCategory::SCHEDULED_MAINTENANCE,
-                slo_data_0_id.clone(),
                 1636629071,
             )
             .description("Example-Service-Level-Objective-Correction".to_string())
             .end(1636632671)
+            .slo_id(slo_data_0_id.clone())
             .timezone("UTC".to_string()),
         ),
     );

examples/v1_service-level-objective-corrections_CreateSLOCorrection_1326388368.rs

@@ -15,12 +15,12 @@ async fn main() {
         SLOCorrectionCreateData::new(SLOCorrectionType::CORRECTION).attributes(
             SLOCorrectionCreateRequestAttributes::new(
                 SLOCorrectionCategory::SCHEDULED_MAINTENANCE,
-                slo_data_0_id.clone(),
                 1636629071,
             )
             .description("Example-Service-Level-Objective-Correction".to_string())
             .duration(3600)
             .rrule("FREQ=DAILY;INTERVAL=10;COUNT=5".to_string())
+            .slo_id(slo_data_0_id.clone())
             .timezone("UTC".to_string()),
         ),
     );

examples/v1_service-level-objective-corrections_CreateSLOCorrection_2888963657.rs

@@ -0,0 +1,32 @@
+// Create an SLO correction with slo_query returns "OK" response
+use datadog_api_client::datadog;
+use datadog_api_client::datadogV1::api_service_level_objective_corrections::ServiceLevelObjectiveCorrectionsAPI;
+use datadog_api_client::datadogV1::model::SLOCorrectionCategory;
+use datadog_api_client::datadogV1::model::SLOCorrectionCreateData;
+use datadog_api_client::datadogV1::model::SLOCorrectionCreateRequest;
+use datadog_api_client::datadogV1::model::SLOCorrectionCreateRequestAttributes;
+use datadog_api_client::datadogV1::model::SLOCorrectionType;
+
+#[tokio::main]
+async fn main() {
+    let body = SLOCorrectionCreateRequest::new().data(
+        SLOCorrectionCreateData::new(SLOCorrectionType::CORRECTION).attributes(
+            SLOCorrectionCreateRequestAttributes::new(
+                SLOCorrectionCategory::SCHEDULED_MAINTENANCE,
+                1636629071,
+            )
+            .description("Example-Service-Level-Objective-Correction".to_string())
+            .end(1636632671)
+            .slo_query("env:prod service:checkout".to_string())
+            .timezone("UTC".to_string()),
+        ),
+    );
+    let configuration = datadog::Configuration::new();
+    let api = ServiceLevelObjectiveCorrectionsAPI::with_config(configuration);
+    let resp = api.create_slo_correction(body).await;
+    if let Ok(value) = resp {
+        println!("{:#?}", value);
+    } else {
+        println!("{:#?}", resp.unwrap_err());
+    }
+}

examples/v1_service-level-objective-corrections_UpdateSLOCorrection_2949191256.rs

@@ -0,0 +1,37 @@
+// Update an SLO correction with slo_query returns "OK" response
+use datadog_api_client::datadog;
+use datadog_api_client::datadogV1::api_service_level_objective_corrections::ServiceLevelObjectiveCorrectionsAPI;
+use datadog_api_client::datadogV1::model::SLOCorrectionCategory;
+use datadog_api_client::datadogV1::model::SLOCorrectionType;
+use datadog_api_client::datadogV1::model::SLOCorrectionUpdateData;
+use datadog_api_client::datadogV1::model::SLOCorrectionUpdateRequest;
+use datadog_api_client::datadogV1::model::SLOCorrectionUpdateRequestAttributes;
+
+#[tokio::main]
+async fn main() {
+    // there is a valid "correction_with_query" in the system
+    let correction_with_query_data_id = std::env::var("CORRECTION_WITH_QUERY_DATA_ID").unwrap();
+    let body = SLOCorrectionUpdateRequest::new().data(
+        SLOCorrectionUpdateData::new()
+            .attributes(
+                SLOCorrectionUpdateRequestAttributes::new()
+                    .category(SLOCorrectionCategory::SCHEDULED_MAINTENANCE)
+                    .description("Example-Service-Level-Objective-Correction".to_string())
+                    .end(1636632671)
+                    .slo_query("env:staging service:checkout".to_string())
+                    .start(1636629071)
+                    .timezone("UTC".to_string()),
+            )
+            .type_(SLOCorrectionType::CORRECTION),
+    );
+    let configuration = datadog::Configuration::new();
+    let api = ServiceLevelObjectiveCorrectionsAPI::with_config(configuration);
+    let resp = api
+        .update_slo_correction(correction_with_query_data_id.clone(), body)
+        .await;
+    if let Ok(value) = resp {
+        println!("{:#?}", value);
+    } else {
+        println!("{:#?}", resp.unwrap_err());
+    }
+}

src/datadogV1/api/api_service_level_objective_corrections.rs

@@ -152,7 +152,8 @@ impl ServiceLevelObjectiveCorrectionsAPI {
         Self { config, client }
     }
 
-    /// Create an SLO Correction.
+    /// Create an SLO correction. Use `slo_id` to apply the correction to a single SLO, or `slo_query` to apply the
+    /// correction to SLOs that match a query. Exactly one of `slo_id` or `slo_query` is required.
     pub async fn create_slo_correction(
         &self,
         body: crate::datadogV1::model::SLOCorrectionCreateRequest,
@@ -174,7 +175,8 @@ impl ServiceLevelObjectiveCorrectionsAPI {
         }
     }
 
-    /// Create an SLO Correction.
+    /// Create an SLO correction. Use `slo_id` to apply the correction to a single SLO, or `slo_query` to apply the
+    /// correction to SLOs that match a query. Exactly one of `slo_id` or `slo_query` is required.
     pub async fn create_slo_correction_with_http_info(
         &self,
         body: crate::datadogV1::model::SLOCorrectionCreateRequest,

src/datadogV1/model/model_slo_correction_create_data.rs

@@ -12,6 +12,8 @@ use std::fmt::{self, Formatter};
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct SLOCorrectionCreateData {
     /// The attribute object associated with the SLO correction to be created.
+    ///
+    /// Exactly one of `slo_id` or `slo_query` must be provided.
     #[serde(rename = "attributes")]
     pub attributes: Option<crate::datadogV1::model::SLOCorrectionCreateRequestAttributes>,
     /// SLO correction resource type.

src/datadogV1/model/model_slo_correction_create_request.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// An object that defines a correction to be applied to an SLO.
+/// An object that defines a correction to be applied to one or more SLOs.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]

src/datadogV1/model/model_slo_correction_create_request_attributes.rs

@@ -7,6 +7,8 @@ use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
 /// The attribute object associated with the SLO correction to be created.
+///
+/// Exactly one of `slo_id` or `slo_query` must be provided.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
@@ -27,9 +29,14 @@ pub struct SLOCorrectionCreateRequestAttributes {
     /// are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`.
     #[serde(rename = "rrule")]
     pub rrule: Option<String>,
-    /// ID of the SLO that this correction applies to.
+    /// ID of the single SLO that this correction applies to.
     #[serde(rename = "slo_id")]
-    pub slo_id: String,
+    pub slo_id: Option<String>,
+    /// Query that matches the SLOs this correction applies to.
+    /// The query uses the [Events search syntax](<https://docs.datadoghq.com/events/explorer/searching/>)
+    /// and can filter SLOs by SLO tags.
+    #[serde(rename = "slo_query")]
+    pub slo_query: Option<String>,
     /// Starting time of the correction in epoch seconds.
     #[serde(rename = "start")]
     pub start: i64,
@@ -46,7 +53,6 @@ pub struct SLOCorrectionCreateRequestAttributes {
 impl SLOCorrectionCreateRequestAttributes {
     pub fn new(
         category: crate::datadogV1::model::SLOCorrectionCategory,
-        slo_id: String,
         start: i64,
     ) -> SLOCorrectionCreateRequestAttributes {
         SLOCorrectionCreateRequestAttributes {
@@ -55,7 +61,8 @@ impl SLOCorrectionCreateRequestAttributes {
             duration: None,
             end: None,
             rrule: None,
-            slo_id,
+            slo_id: None,
+            slo_query: None,
             start,
             timezone: None,
             additional_properties: std::collections::BTreeMap::new(),
@@ -83,6 +90,16 @@ impl SLOCorrectionCreateRequestAttributes {
         self
     }
 
+    pub fn slo_id(mut self, value: String) -> Self {
+        self.slo_id = Some(value);
+        self
+    }
+
+    pub fn slo_query(mut self, value: String) -> Self {
+        self.slo_query = Some(value);
+        self
+    }
+
     pub fn timezone(mut self, value: String) -> Self {
         self.timezone = Some(value);
         self
@@ -120,6 +137,7 @@ impl<'de> Deserialize<'de> for SLOCorrectionCreateRequestAttributes {
                 let mut end: Option<i64> = None;
                 let mut rrule: Option<String> = None;
                 let mut slo_id: Option<String> = None;
+                let mut slo_query: Option<String> = None;
                 let mut start: Option<i64> = None;
                 let mut timezone: Option<String> = None;
                 let mut additional_properties: std::collections::BTreeMap<
@@ -167,8 +185,17 @@ impl<'de> Deserialize<'de> for SLOCorrectionCreateRequestAttributes {
                             rrule = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
                         "slo_id" => {
+                            if v.is_null() {
+                                continue;
+                            }
                             slo_id = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
+                        "slo_query" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            slo_query = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "start" => {
                             start = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
@@ -186,7 +213,6 @@ impl<'de> Deserialize<'de> for SLOCorrectionCreateRequestAttributes {
                     }
                 }
                 let category = category.ok_or_else(|| M::Error::missing_field("category"))?;
-                let slo_id = slo_id.ok_or_else(|| M::Error::missing_field("slo_id"))?;
                 let start = start.ok_or_else(|| M::Error::missing_field("start"))?;
 
                 let content = SLOCorrectionCreateRequestAttributes {
@@ -196,6 +222,7 @@ impl<'de> Deserialize<'de> for SLOCorrectionCreateRequestAttributes {
                     end,
                     rrule,
                     slo_id,
+                    slo_query,
                     start,
                     timezone,
                     additional_properties,