Update documentation of v2 endpoints for RUM retention filters.

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-06 21:28:37.526759",
-            "spec_repo_commit": "d6a6faf6"
+            "regenerated": "2025-03-10 19:56:04.194124",
+            "spec_repo_commit": "04a593ef"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-06 21:28:37.542319",
-            "spec_repo_commit": "d6a6faf6"
+            "regenerated": "2025-03-10 19:56:04.209668",
+            "spec_repo_commit": "04a593ef"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -684,7 +684,7 @@ components:
       schema:
         type: string
     RumApplicationIDParameter:
-      description: Application ID.
+      description: RUM application ID.
       in: path
       name: app_id
       required: true
@@ -25579,7 +25579,9 @@ components:
       minimum: 0
       type: integer
     RumRetentionFilterSource:
-      description: The type of RUM events to filter on.
+      description: The origin source of the retention filter, which may be created
+        or updated through the Datadog UI, terraform, or other channels such as direct
+        API calls.
       enum:
       - ui
       - terraform
@@ -25654,7 +25656,8 @@ components:
       description: 'The list of RUM retention filter IDs along with their corresponding
         type to reorder.
 
-        All retention filter IDs should be included in the list created for an application.'
+        All retention filter IDs should be included in the list created for a RUM
+        application.'
       properties:
         data:
           description: A list of RUM retention filter IDs along with type.
@@ -25672,7 +25675,7 @@ components:
           type: array
       type: object
     RumRetentionFiltersResponse:
-      description: All RUM retention filters for an application.
+      description: All RUM retention filters for a RUM application.
       properties:
         data:
           description: A list of RUM retention filters.
@@ -46225,7 +46228,7 @@ paths:
         - rum_apps_write
   /api/v2/rum/applications/{app_id}/relationships/retention_filters:
     patch:
-      description: 'Order RUM retention filters for an application.
+      description: 'Order RUM retention filters for a RUM application.
 
         Returns RUM retention filter objects without attributes and meta from the
         request body when the request is successful.'
@@ -46258,7 +46261,7 @@ paths:
       x-codegen-request-body-name: body
   /api/v2/rum/applications/{app_id}/retention_filters:
     get:
-      description: Get the list of RUM retention filters for an application.
+      description: Get the list of RUM retention filters for a RUM application.
       operationId: ListRetentionFilters
       parameters:
       - $ref: '#/components/parameters/RumApplicationIDParameter'
@@ -46277,7 +46280,7 @@ paths:
       tags:
       - Rum Retention Filters
     post:
-      description: 'Create a RUM retention filter for an application.
+      description: 'Create a RUM retention filter for a RUM application.
 
         Returns RUM retention filter objects from the request body when the request
         is successful.'
@@ -46310,7 +46313,7 @@ paths:
       x-codegen-request-body-name: body
   /api/v2/rum/applications/{app_id}/retention_filters/{rf_id}:
     delete:
-      description: Delete a RUM retention filter for an application.
+      description: Delete a RUM retention filter for a RUM application.
       operationId: DeleteRetentionFilter
       parameters:
       - $ref: '#/components/parameters/RumApplicationIDParameter'
@@ -46328,7 +46331,7 @@ paths:
       tags:
       - Rum Retention Filters
     get:
-      description: Get a RUM retention filter for an application.
+      description: Get a RUM retention filter for a RUM application.
       operationId: GetRetentionFilter
       parameters:
       - $ref: '#/components/parameters/RumApplicationIDParameter'
@@ -46350,7 +46353,7 @@ paths:
       tags:
       - Rum Retention Filters
     patch:
-      description: 'Update a RUM retention filter for an application.
+      description: 'Update a RUM retention filter for a RUM application.
 
         Returns RUM retention filter objects from the request body when the request
         is successful.'
@@ -53800,7 +53803,7 @@ tags:
     url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/
   name: Rum Metrics
 - description: Manage retention filters through [Manage Applications](https://app.datadoghq.com/rum/list)
-    for your organization.
+    of RUM for your organization.
   name: Rum Retention Filters
 - description: Create and manage your security rules, signals, filters, and more.
     See the [Datadog Security page](https://docs.datadoghq.com/security/) for more

LICENSE-3rdparty.csv

@@ -11,7 +11,6 @@ base64,https://github.com/marshallpierce/rust-base64,MIT OR Apache-2.0,"Alice Ma
 base64,https://github.com/marshallpierce/rust-base64,MIT OR Apache-2.0,Marshall Pierce <[email protected]>
 bitflags,https://github.com/bitflags/bitflags,MIT OR Apache-2.0,The Rust Project Developers
 bumpalo,https://github.com/fitzgen/bumpalo,MIT OR Apache-2.0,Nick Fitzgerald <[email protected]>
-byteorder,https://github.com/BurntSushi/byteorder,Unlicense OR MIT,Andrew Gallant <[email protected]>
 bytes,https://github.com/tokio-rs/bytes,MIT,"Carl Lerche <[email protected]>, Sean McArthur <[email protected]>"
 cfg-if,https://github.com/alexcrichton/cfg-if,MIT OR Apache-2.0,Alex Crichton <[email protected]>
 chrono,https://github.com/chronotope/chrono,MIT OR Apache-2.0,The chrono Authors
@@ -172,7 +171,6 @@ write16,https://github.com/hsivonen/write16,Apache-2.0 OR MIT,The write16 Author
 writeable,https://github.com/unicode-org/icu4x,Unicode-3.0,The ICU4X Project Developers
 yoke,https://github.com/unicode-org/icu4x,Unicode-3.0,Manish Goregaokar <[email protected]>
 yoke-derive,https://github.com/unicode-org/icu4x,Unicode-3.0,Manish Goregaokar <[email protected]>
-zerocopy,https://github.com/google/zerocopy,BSD-2-Clause OR Apache-2.0 OR MIT,Joshua Liebow-Feeser <[email protected]>
 zerocopy,https://github.com/google/zerocopy,BSD-2-Clause OR Apache-2.0 OR MIT,"Joshua Liebow-Feeser <[email protected]>, Jack Wrenn <[email protected]>"
 zerofrom,https://github.com/unicode-org/icu4x,Unicode-3.0,Manish Goregaokar <[email protected]>
 zerofrom-derive,https://github.com/unicode-org/icu4x,Unicode-3.0,Manish Goregaokar <[email protected]>

src/datadogV2/api/api_rum_retention_filters.rs

@@ -58,7 +58,7 @@ pub enum UpdateRetentionFilterError {
     UnknownValue(serde_json::Value),
 }
 
-/// Manage retention filters through [Manage Applications](<https://app.datadoghq.com/rum/list>) for your organization.
+/// Manage retention filters through [Manage Applications](<https://app.datadoghq.com/rum/list>) of RUM for your organization.
 #[derive(Debug, Clone)]
 pub struct RumRetentionFiltersAPI {
     config: datadog::Configuration,
@@ -123,7 +123,7 @@ impl RumRetentionFiltersAPI {
         Self { config, client }
     }
 
-    /// Create a RUM retention filter for an application.
+    /// Create a RUM retention filter for a RUM application.
     /// Returns RUM retention filter objects from the request body when the request is successful.
     pub async fn create_retention_filter(
         &self,
@@ -150,7 +150,7 @@ impl RumRetentionFiltersAPI {
         }
     }
 
-    /// Create a RUM retention filter for an application.
+    /// Create a RUM retention filter for a RUM application.
     /// Returns RUM retention filter objects from the request body when the request is successful.
     pub async fn create_retention_filter_with_http_info(
         &self,
@@ -285,7 +285,7 @@ impl RumRetentionFiltersAPI {
         }
     }
 
-    /// Delete a RUM retention filter for an application.
+    /// Delete a RUM retention filter for a RUM application.
     pub async fn delete_retention_filter(
         &self,
         app_id: String,
@@ -300,7 +300,7 @@ impl RumRetentionFiltersAPI {
         }
     }
 
-    /// Delete a RUM retention filter for an application.
+    /// Delete a RUM retention filter for a RUM application.
     pub async fn delete_retention_filter_with_http_info(
         &self,
         app_id: String,
@@ -379,7 +379,7 @@ impl RumRetentionFiltersAPI {
         }
     }
 
-    /// Get a RUM retention filter for an application.
+    /// Get a RUM retention filter for a RUM application.
     pub async fn get_retention_filter(
         &self,
         app_id: String,
@@ -405,7 +405,7 @@ impl RumRetentionFiltersAPI {
         }
     }
 
-    /// Get a RUM retention filter for an application.
+    /// Get a RUM retention filter for a RUM application.
     pub async fn get_retention_filter_with_http_info(
         &self,
         app_id: String,
@@ -494,7 +494,7 @@ impl RumRetentionFiltersAPI {
         }
     }
 
-    /// Get the list of RUM retention filters for an application.
+    /// Get the list of RUM retention filters for a RUM application.
     pub async fn list_retention_filters(
         &self,
         app_id: String,
@@ -516,7 +516,7 @@ impl RumRetentionFiltersAPI {
         }
     }
 
-    /// Get the list of RUM retention filters for an application.
+    /// Get the list of RUM retention filters for a RUM application.
     pub async fn list_retention_filters_with_http_info(
         &self,
         app_id: String,
@@ -603,7 +603,7 @@ impl RumRetentionFiltersAPI {
         }
     }
 
-    /// Order RUM retention filters for an application.
+    /// Order RUM retention filters for a RUM application.
     /// Returns RUM retention filter objects without attributes and meta from the request body when the request is successful.
     pub async fn order_retention_filters(
         &self,
@@ -630,7 +630,7 @@ impl RumRetentionFiltersAPI {
         }
     }
 
-    /// Order RUM retention filters for an application.
+    /// Order RUM retention filters for a RUM application.
     /// Returns RUM retention filter objects without attributes and meta from the request body when the request is successful.
     pub async fn order_retention_filters_with_http_info(
         &self,
@@ -765,7 +765,7 @@ impl RumRetentionFiltersAPI {
         }
     }
 
-    /// Update a RUM retention filter for an application.
+    /// Update a RUM retention filter for a RUM application.
     /// Returns RUM retention filter objects from the request body when the request is successful.
     pub async fn update_retention_filter(
         &self,
@@ -793,7 +793,7 @@ impl RumRetentionFiltersAPI {
         }
     }
 
-    /// Update a RUM retention filter for an application.
+    /// Update a RUM retention filter for a RUM application.
     /// Returns RUM retention filter objects from the request body when the request is successful.
     pub async fn update_retention_filter_with_http_info(
         &self,

src/datadogV2/model/model_rum_retention_filter_meta.rs

@@ -11,7 +11,7 @@ use std::fmt::{self, Formatter};
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct RumRetentionFilterMeta {
-    /// The type of RUM events to filter on.
+    /// The origin source of the retention filter, which may be created or updated through the Datadog UI, terraform, or other channels such as direct API calls.
     #[serde(rename = "source")]
     pub source: Option<crate::datadogV2::model::RumRetentionFilterSource>,
     #[serde(flatten)]

src/datadogV2/model/model_rum_retention_filters_order_request.rs

@@ -7,7 +7,7 @@ use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
 /// The list of RUM retention filter IDs along with their corresponding type to reorder.
-/// All retention filter IDs should be included in the list created for an application.
+/// All retention filter IDs should be included in the list created for a RUM application.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]

src/datadogV2/model/model_rum_retention_filters_response.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// All RUM retention filters for an application.
+/// All RUM retention filters for a RUM application.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]

tests/scenarios/features/v2/rum_retention_filters.feature

@@ -1,7 +1,8 @@
 @endpoint(rum-retention-filters) @endpoint(rum-retention-filters-v2)
 Feature: Rum Retention Filters
   Manage retention filters through [Manage
-  Applications](https://app.datadoghq.com/rum/list) for your organization.
+  Applications](https://app.datadoghq.com/rum/list) of RUM for your
+  organization.
 
   Background:
     Given a valid "apiKeyAuth" key in the system