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:39.406736",
-            "spec_repo_commit": "d6a6faf6"
+            "regenerated": "2025-03-10 19:56:02.946582",
+            "spec_repo_commit": "04a593ef"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-06 21:28:39.424165",
-            "spec_repo_commit": "d6a6faf6"
+            "regenerated": "2025-03-10 19:56:02.962204",
+            "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

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

lib/datadog_api_client/v2/api/rum_retention_filters_api.rb

@@ -33,10 +33,10 @@ def create_retention_filter(app_id, body, opts = {})
 
     # Create a RUM retention filter.
     #
-    # 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.
     #
-    # @param app_id [String] Application ID.
+    # @param app_id [String] RUM application ID.
     # @param body [RumRetentionFilterCreateRequest] The definition of the new RUM retention filter.
     # @param opts [Hash] the optional parameters
     # @return [Array<(RumRetentionFilterResponse, Integer, Hash)>] RumRetentionFilterResponse data, response status code and response headers
@@ -106,9 +106,9 @@ def delete_retention_filter(app_id, rf_id, opts = {})
 
     # Delete a RUM retention filter.
     #
-    # Delete a RUM retention filter for an application.
+    # Delete a RUM retention filter for a RUM application.
     #
-    # @param app_id [String] Application ID.
+    # @param app_id [String] RUM application ID.
     # @param rf_id [String] Retention filter ID.
     # @param opts [Hash] the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -176,9 +176,9 @@ def get_retention_filter(app_id, rf_id, opts = {})
 
     # Get a RUM retention filter.
     #
-    # Get a RUM retention filter for an application.
+    # Get a RUM retention filter for a RUM application.
     #
-    # @param app_id [String] Application ID.
+    # @param app_id [String] RUM application ID.
     # @param rf_id [String] Retention filter ID.
     # @param opts [Hash] the optional parameters
     # @return [Array<(RumRetentionFilterResponse, Integer, Hash)>] RumRetentionFilterResponse data, response status code and response headers
@@ -246,9 +246,9 @@ def list_retention_filters(app_id, opts = {})
 
     # Get all RUM retention filters.
     #
-    # Get the list of RUM retention filters for an application.
+    # Get the list of RUM retention filters for a RUM application.
     #
-    # @param app_id [String] Application ID.
+    # @param app_id [String] RUM application ID.
     # @param opts [Hash] the optional parameters
     # @return [Array<(RumRetentionFiltersResponse, Integer, Hash)>] RumRetentionFiltersResponse data, response status code and response headers
     def list_retention_filters_with_http_info(app_id, opts = {})
@@ -311,10 +311,10 @@ def order_retention_filters(app_id, body, opts = {})
 
     # Order RUM retention filters.
     #
-    # 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.
     #
-    # @param app_id [String] Application ID.
+    # @param app_id [String] RUM application ID.
     # @param body [RumRetentionFiltersOrderRequest] New definition of the RUM retention filter.
     # @param opts [Hash] the optional parameters
     # @return [Array<(RumRetentionFiltersOrderResponse, Integer, Hash)>] RumRetentionFiltersOrderResponse data, response status code and response headers
@@ -384,10 +384,10 @@ def update_retention_filter(app_id, rf_id, body, opts = {})
 
     # Update a RUM retention filter.
     #
-    # 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.
     #
-    # @param app_id [String] Application ID.
+    # @param app_id [String] RUM application ID.
     # @param rf_id [String] Retention filter ID.
     # @param body [RumRetentionFilterUpdateRequest] New definition of the RUM retention filter.
     # @param opts [Hash] the optional parameters

lib/datadog_api_client/v2/models/rum_retention_filter_meta.rb

@@ -21,7 +21,7 @@ module DatadogAPIClient::V2
   class RumRetentionFilterMeta
     include BaseGenericModel
 
-    # 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.
     attr_accessor :source
 
     attr_accessor :additional_properties

lib/datadog_api_client/v2/models/rum_retention_filter_source.rb

@@ -17,7 +17,7 @@
 require 'time'
 
 module DatadogAPIClient::V2
-  # 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.
   class RumRetentionFilterSource
     include BaseEnumModel
 

lib/datadog_api_client/v2/models/rum_retention_filters_order_request.rb

@@ -18,7 +18,7 @@
 
 module DatadogAPIClient::V2
   # 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.
   class RumRetentionFiltersOrderRequest
     include BaseGenericModel
 

lib/datadog_api_client/v2/models/rum_retention_filters_response.rb

@@ -17,7 +17,7 @@
 require 'time'
 
 module DatadogAPIClient::V2
-  # All RUM retention filters for an application.
+  # All RUM retention filters for a RUM application.
   class RumRetentionFiltersResponse
     include BaseGenericModel