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.951420",
-            "spec_repo_commit": "d6a6faf6"
+            "regenerated": "2025-03-10 19:56:00.239445",
+            "spec_repo_commit": "04a593ef"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-06 21:28:37.967105",
-            "spec_repo_commit": "d6a6faf6"
+            "regenerated": "2025-03-10 19:56:00.254549",
+            "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

src/datadog_api_client/v2/api/rum_retention_filters_api.py

@@ -17,7 +17,7 @@
 
 class RumRetentionFiltersApi:
     """
-    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.
     """
 
     def __init__(self, api_client=None):
@@ -197,10 +197,10 @@ def create_retention_filter(
     ) -> RumRetentionFilterResponse:
         """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: Application ID.
+        :param app_id: RUM application ID.
         :type app_id: str
         :param body: The definition of the new RUM retention filter.
         :type body: RumRetentionFilterCreateRequest
@@ -220,9 +220,9 @@ def delete_retention_filter(
     ) -> None:
         """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: Application ID.
+        :param app_id: RUM application ID.
         :type app_id: str
         :param rf_id: Retention filter ID.
         :type rf_id: str
@@ -242,9 +242,9 @@ def get_retention_filter(
     ) -> RumRetentionFilterResponse:
         """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: Application ID.
+        :param app_id: RUM application ID.
         :type app_id: str
         :param rf_id: Retention filter ID.
         :type rf_id: str
@@ -263,9 +263,9 @@ def list_retention_filters(
     ) -> RumRetentionFiltersResponse:
         """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: Application ID.
+        :param app_id: RUM application ID.
         :type app_id: str
         :rtype: RumRetentionFiltersResponse
         """
@@ -281,10 +281,10 @@ def order_retention_filters(
     ) -> RumRetentionFiltersOrderResponse:
         """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: Application ID.
+        :param app_id: RUM application ID.
         :type app_id: str
         :param body: New definition of the RUM retention filter.
         :type body: RumRetentionFiltersOrderRequest
@@ -305,10 +305,10 @@ def update_retention_filter(
     ) -> RumRetentionFilterResponse:
         """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: Application ID.
+        :param app_id: RUM application ID.
         :type app_id: str
         :param rf_id: Retention filter ID.
         :type rf_id: str

src/datadog_api_client/v2/model/rum_retention_filter_meta.py

@@ -34,7 +34,7 @@ def __init__(self_, source: Union[RumRetentionFilterSource, UnsetType] = unset,
         """
         The object describing metadata of a RUM retention filter.
 
-        :param source: The type of RUM events to filter on.
+        :param source: 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.
         :type source: RumRetentionFilterSource, optional
         """
         if source is not unset:

src/datadog_api_client/v2/model/rum_retention_filter_source.py

@@ -14,7 +14,7 @@
 
 class RumRetentionFilterSource(ModelSimple):
     """
-    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.
 
     :param value: Must be one of ["ui", "terraform", "default", "unknown"].
     :type value: str

src/datadog_api_client/v2/model/rum_retention_filters_order_request.py

@@ -33,7 +33,7 @@ def openapi_types(_):
     def __init__(self_, data: Union[List[RumRetentionFiltersOrderData], UnsetType] = unset, **kwargs):
         """
         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.
 
         :param data: A list of RUM retention filter IDs along with type.
         :type data: [RumRetentionFiltersOrderData], optional

src/datadog_api_client/v2/model/rum_retention_filters_response.py

@@ -32,7 +32,7 @@ def openapi_types(_):
 
     def __init__(self_, data: Union[List[RumRetentionFilterData], UnsetType] = unset, **kwargs):
         """
-        All RUM retention filters for an application.
+        All RUM retention filters for a RUM application.
 
         :param data: A list of RUM retention filters.
         :type data: [RumRetentionFilterData], optional

tests/v2/features/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