Update retention filters public API (#74)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 636a2e741553 · 2024-04-11T17:19:05.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
Co-authored-by: api-clients-generation-pipeline[bot] &lt;54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-10 19:44:58.186735",
-            "spec_repo_commit": "3fb610b5"
+            "regenerated": "2024-04-11 15:35:27.700324",
+            "spec_repo_commit": "8ffb168c"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-10 19:44:58.204246",
-            "spec_repo_commit": "3fb610b5"
+            "regenerated": "2024-04-11 15:35:27.721018",
+            "spec_repo_commit": "8ffb168c"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -16072,6 +16072,7 @@ components:
       - spans-sampling-processor
       - spans-errors-sampling-processor
       - spans-appsec-sampling-processor
+      example: spans-sampling-processor
       type: string
       x-enum-varnames:
       - SPANS_SAMPLING_PROCESSOR
@@ -16188,11 +16189,42 @@ components:
       type: string
       x-enum-varnames:
       - SPANS_SAMPLING_PROCESSOR
+    RetentionFilterUpdateAttributes:
+      description: The object describing the configuration of the retention filter
+        to create/update.
+      properties:
+        enabled:
+          description: Enable/Disable the retention filter.
+          example: true
+          type: boolean
+        filter:
+          $ref: '#/components/schemas/SpansFilterCreate'
+        filter_type:
+          $ref: '#/components/schemas/RetentionFilterAllType'
+        name:
+          description: The name of the retention filter.
+          example: my retention filter
+          type: string
+        rate:
+          description: 'Sample rate to apply to spans going through this retention
+            filter,
+
+            a value of 1.0 keeps all spans matching the query.'
+          example: 1.0
+          format: double
+          type: number
+      required:
+      - name
+      - filter
+      - enabled
+      - filter_type
+      - rate
+      type: object
     RetentionFilterUpdateData:
       description: The body of the retention filter to be updated.
       properties:
         attributes:
-          $ref: '#/components/schemas/RetentionFilterCreateAttributes'
+          $ref: '#/components/schemas/RetentionFilterUpdateAttributes'
         id:
           description: The ID of the retention filter.
           example: retention-filter-id
@@ -23271,7 +23303,11 @@ paths:
     post:
       description: 'Create a retention filter to index spans in your organization.
 
-        Returns the retention filter definition when the request is successful.'
+        Returns the retention filter definition when the request is successful.
+
+
+        Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor
+        cannot be created.'
       operationId: CreateApmRetentionFilter
       requestBody:
         content:
@@ -23325,7 +23361,11 @@ paths:
       x-codegen-request-body-name: body
   /api/v2/apm/config/retention-filters/{filter_id}:
     delete:
-      description: Delete a specific retention filter from your organization.
+      description: 'Delete a specific retention filter from your organization.
+
+
+        Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor
+        cannot be deleted.'
       operationId: DeleteApmRetentionFilter
       parameters:
       - $ref: '#/components/parameters/RetentionFilterIdParam'
@@ -23363,7 +23403,11 @@ paths:
       tags:
       - APM Retention Filters
     put:
-      description: Update a retention filter from your organization.
+      description: 'Update a retention filter from your organization.
+
+
+        Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor)
+        cannot be renamed or removed.'
       operationId: UpdateApmRetentionFilter
       parameters:
       - $ref: '#/components/parameters/RetentionFilterIdParam'
diff --git a/examples/v2_apm-retention-filters_update_apm_retention_filter.rs b/examples/v2_apm-retention-filters_update_apm_retention_filter.rs
@@ -2,8 +2,8 @@
 use datadog_api_client::datadog;
 use datadog_api_client::datadogV2::api_apm_retention_filters::APMRetentionFiltersAPI;
 use datadog_api_client::datadogV2::model::ApmRetentionFilterType;
-use datadog_api_client::datadogV2::model::RetentionFilterCreateAttributes;
-use datadog_api_client::datadogV2::model::RetentionFilterType;
+use datadog_api_client::datadogV2::model::RetentionFilterAllType;
+use datadog_api_client::datadogV2::model::RetentionFilterUpdateAttributes;
 use datadog_api_client::datadogV2::model::RetentionFilterUpdateData;
 use datadog_api_client::datadogV2::model::RetentionFilterUpdateRequest;
 use datadog_api_client::datadogV2::model::SpansFilterCreate;
@@ -13,10 +13,10 @@ async fn main() {
     // there is a valid "retention_filter" in the system
     let retention_filter_data_id = std::env::var("RETENTION_FILTER_DATA_ID").unwrap();
     let body = RetentionFilterUpdateRequest::new(RetentionFilterUpdateData::new(
-        RetentionFilterCreateAttributes::new(
+        RetentionFilterUpdateAttributes::new(
             true,
             SpansFilterCreate::new("@_top_level:1 test:service-demo".to_string()),
-            RetentionFilterType::SPANS_SAMPLING_PROCESSOR,
+            RetentionFilterAllType::SPANS_SAMPLING_PROCESSOR,
             "test".to_string(),
             0.9,
         ),
diff --git a/src/datadogV2/api/api_apm_retention_filters.rs b/src/datadogV2/api/api_apm_retention_filters.rs
@@ -138,6 +138,8 @@ impl APMRetentionFiltersAPI {
 
     /// Create a retention filter to index spans in your organization.
     /// Returns the retention filter definition when the request is successful.
+    ///
+    /// Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be created.
     pub async fn create_apm_retention_filter(
         &self,
         body: crate::datadogV2::model::RetentionFilterCreateRequest,
@@ -161,6 +163,8 @@ impl APMRetentionFiltersAPI {
 
     /// Create a retention filter to index spans in your organization.
     /// Returns the retention filter definition when the request is successful.
+    ///
+    /// Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be created.
     pub async fn create_apm_retention_filter_with_http_info(
         &self,
         body: crate::datadogV2::model::RetentionFilterCreateRequest,
@@ -291,6 +295,8 @@ impl APMRetentionFiltersAPI {
     }
 
     /// Delete a specific retention filter from your organization.
+    ///
+    /// Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be deleted.
     pub async fn delete_apm_retention_filter(
         &self,
         filter_id: String,
@@ -305,6 +311,8 @@ impl APMRetentionFiltersAPI {
     }
 
     /// Delete a specific retention filter from your organization.
+    ///
+    /// Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be deleted.
     pub async fn delete_apm_retention_filter_with_http_info(
         &self,
         filter_id: String,
@@ -728,6 +736,8 @@ impl APMRetentionFiltersAPI {
     }
 
     /// Update a retention filter from your organization.
+    ///
+    /// Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor) cannot be renamed or removed.
     pub async fn update_apm_retention_filter(
         &self,
         filter_id: String,
@@ -754,6 +764,8 @@ impl APMRetentionFiltersAPI {
     }
 
     /// Update a retention filter from your organization.
+    ///
+    /// Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor) cannot be renamed or removed.
     pub async fn update_apm_retention_filter_with_http_info(
         &self,
         filter_id: String,
diff --git a/src/datadogV2/model/mod.rs b/src/datadogV2/model/mod.rs
@@ -162,6 +162,8 @@ pub mod model_retention_filter_update_request;
 pub use self::model_retention_filter_update_request::RetentionFilterUpdateRequest;
 pub mod model_retention_filter_update_data;
 pub use self::model_retention_filter_update_data::RetentionFilterUpdateData;
+pub mod model_retention_filter_update_attributes;
+pub use self::model_retention_filter_update_attributes::RetentionFilterUpdateAttributes;
 pub mod model_application_keys_sort;
 pub use self::model_application_keys_sort::ApplicationKeysSort;
 pub mod model_list_application_keys_response;
diff --git a/src/datadogV2/model/model_retention_filter_update_attributes.rs b/src/datadogV2/model/model_retention_filter_update_attributes.rs
@@ -0,0 +1,129 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2019-Present Datadog, Inc.
+use serde::de::{Error, MapAccess, Visitor};
+use serde::{Deserialize, Deserializer, Serialize};
+use serde_with::skip_serializing_none;
+use std::fmt::{self, Formatter};
+
+/// The object describing the configuration of the retention filter to create/update.
+#[non_exhaustive]
+#[skip_serializing_none]
+#[derive(Clone, Debug, PartialEq, Serialize)]
+pub struct RetentionFilterUpdateAttributes {
+    /// Enable/Disable the retention filter.
+    #[serde(rename = "enabled")]
+    pub enabled: bool,
+    /// The spans filter. Spans matching this filter will be indexed and stored.
+    #[serde(rename = "filter")]
+    pub filter: crate::datadogV2::model::SpansFilterCreate,
+    /// The type of retention filter.
+    #[serde(rename = "filter_type")]
+    pub filter_type: crate::datadogV2::model::RetentionFilterAllType,
+    /// The name of the retention filter.
+    #[serde(rename = "name")]
+    pub name: String,
+    /// Sample rate to apply to spans going through this retention filter,
+    /// a value of 1.0 keeps all spans matching the query.
+    #[serde(rename = "rate")]
+    pub rate: f64,
+    #[serde(skip)]
+    #[serde(default)]
+    pub(crate) _unparsed: bool,
+}
+
+impl RetentionFilterUpdateAttributes {
+    pub fn new(
+        enabled: bool,
+        filter: crate::datadogV2::model::SpansFilterCreate,
+        filter_type: crate::datadogV2::model::RetentionFilterAllType,
+        name: String,
+        rate: f64,
+    ) -> RetentionFilterUpdateAttributes {
+        RetentionFilterUpdateAttributes {
+            enabled,
+            filter,
+            filter_type,
+            name,
+            rate,
+            _unparsed: false,
+        }
+    }
+}
+
+impl<'de> Deserialize<'de> for RetentionFilterUpdateAttributes {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        struct RetentionFilterUpdateAttributesVisitor;
+        impl<'a> Visitor<'a> for RetentionFilterUpdateAttributesVisitor {
+            type Value = RetentionFilterUpdateAttributes;
+
+            fn expecting(&self, f: &mut Formatter<'_>) -> fmt::Result {
+                f.write_str("a mapping")
+            }
+
+            fn visit_map<M>(self, mut map: M) -> Result<Self::Value, M::Error>
+            where
+                M: MapAccess<'a>,
+            {
+                let mut enabled: Option<bool> = None;
+                let mut filter: Option<crate::datadogV2::model::SpansFilterCreate> = None;
+                let mut filter_type: Option<crate::datadogV2::model::RetentionFilterAllType> = None;
+                let mut name: Option<String> = None;
+                let mut rate: Option<f64> = None;
+                let mut _unparsed = false;
+
+                while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
+                    match k.as_str() {
+                        "enabled" => {
+                            enabled = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
+                        "filter" => {
+                            filter = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
+                        "filter_type" => {
+                            filter_type =
+                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                            if let Some(ref _filter_type) = filter_type {
+                                match _filter_type {
+                                    crate::datadogV2::model::RetentionFilterAllType::UnparsedObject(_filter_type) => {
+                                        _unparsed = true;
+                                    },
+                                    _ => {}
+                                }
+                            }
+                        }
+                        "name" => {
+                            name = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
+                        "rate" => {
+                            rate = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
+                        &_ => {}
+                    }
+                }
+                let enabled = enabled.ok_or_else(|| M::Error::missing_field("enabled"))?;
+                let filter = filter.ok_or_else(|| M::Error::missing_field("filter"))?;
+                let filter_type =
+                    filter_type.ok_or_else(|| M::Error::missing_field("filter_type"))?;
+                let name = name.ok_or_else(|| M::Error::missing_field("name"))?;
+                let rate = rate.ok_or_else(|| M::Error::missing_field("rate"))?;
+
+                let content = RetentionFilterUpdateAttributes {
+                    enabled,
+                    filter,
+                    filter_type,
+                    name,
+                    rate,
+                    _unparsed,
+                };
+
+                Ok(content)
+            }
+        }
+
+        deserializer.deserialize_any(RetentionFilterUpdateAttributesVisitor)
+    }
+}
diff --git a/src/datadogV2/model/model_retention_filter_update_data.rs b/src/datadogV2/model/model_retention_filter_update_data.rs
@@ -13,7 +13,7 @@ use std::fmt::{self, Formatter};
 pub struct RetentionFilterUpdateData {
     /// The object describing the configuration of the retention filter to create/update.
     #[serde(rename = "attributes")]
-    pub attributes: crate::datadogV2::model::RetentionFilterCreateAttributes,
+    pub attributes: crate::datadogV2::model::RetentionFilterUpdateAttributes,
     /// The ID of the retention filter.
     #[serde(rename = "id")]
     pub id: String,
@@ -27,7 +27,7 @@ pub struct RetentionFilterUpdateData {
 
 impl RetentionFilterUpdateData {
     pub fn new(
-        attributes: crate::datadogV2::model::RetentionFilterCreateAttributes,
+        attributes: crate::datadogV2::model::RetentionFilterUpdateAttributes,
         id: String,
         type_: crate::datadogV2::model::ApmRetentionFilterType,
     ) -> RetentionFilterUpdateData {
@@ -58,7 +58,7 @@ impl<'de> Deserialize<'de> for RetentionFilterUpdateData {
                 M: MapAccess<'a>,
             {
                 let mut attributes: Option<
-                    crate::datadogV2::model::RetentionFilterCreateAttributes,
+                    crate::datadogV2::model::RetentionFilterUpdateAttributes,
                 > = None;
                 let mut id: Option<String> = None;
                 let mut type_: Option<crate::datadogV2::model::ApmRetentionFilterType> = None;
diff --git a/tests/scenarios/cassettes/v2/apm_retention_filters/Create-a-default-retention-filter-returns-Bad-Request-response.frozen b/tests/scenarios/cassettes/v2/apm_retention_filters/Create-a-default-retention-filter-returns-Bad-Request-response.frozen
@@ -0,0 +1 @@
+2024-04-10T12:31:19.300Z
diff --git a/tests/scenarios/cassettes/v2/apm_retention_filters/Create-a-default-retention-filter-returns-Bad-Request-response.json b/tests/scenarios/cassettes/v2/apm_retention_filters/Create-a-default-retention-filter-returns-Bad-Request-response.json
@@ -0,0 +1,39 @@
+{
+  "http_interactions": [
+    {
+      "request": {
+        "body": {
+          "string": "{\"data\":{\"attributes\":{\"enabled\":true,\"filter\":{\"query\":\"@http.status_code:200 service:my-service\"},\"filter_type\":\"spans-errors-sampling-processor\",\"name\":\"my retention filter\",\"rate\":1},\"type\":\"apm_retention_filter\"}}",
+          "encoding": null
+        },
+        "headers": {
+          "Accept": [
+            "application/json"
+          ],
+          "Content-Type": [
+            "application/json"
+          ]
+        },
+        "method": "post",
+        "uri": "https://api.datadoghq.com/api/v2/apm/config/retention-filters"
+      },
+      "response": {
+        "body": {
+          "string": "{\"errors\":[\"Field 'filter_type' is invalid, expected value is 'spans-sampling-processor'\"]}",
+          "encoding": null
+        },
+        "headers": {
+          "Content-Type": [
+            "application/json"
+          ]
+        },
+        "status": {
+          "code": 400,
+          "message": "Bad Request"
+        }
+      },
+      "recorded_at": "Wed, 10 Apr 2024 12:31:19 GMT"
+    }
+  ],
+  "recorded_with": "VCR 6.0.0"
+}
diff --git a/tests/scenarios/features/v2/apm_retention_filters.feature b/tests/scenarios/features/v2/apm_retention_filters.feature

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.6",`
`7`		`- "regenerated": "2024-04-10 19:44:58.186735",`
`8`		`- "spec_repo_commit": "3fb610b5"`
	`7`	`+ "regenerated": "2024-04-11 15:35:27.700324",`
	`8`	`+ "spec_repo_commit": "8ffb168c"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2024-04-10 19:44:58.204246",`
`13`		`- "spec_repo_commit": "3fb610b5"`
	`12`	`+ "regenerated": "2024-04-11 15:35:27.721018",`
	`13`	`+ "spec_repo_commit": "8ffb168c"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`