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:34.346014",
-            "spec_repo_commit": "d6a6faf6"
+            "regenerated": "2025-03-10 19:55:58.030685",
+            "spec_repo_commit": "04a593ef"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-06 21:28:34.361861",
-            "spec_repo_commit": "d6a6faf6"
+            "regenerated": "2025-03-10 19:55:58.045806",
+            "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/main/java/com/datadog/api/client/v2/api/RumRetentionFiltersApi.java

@@ -53,7 +53,7 @@ public void setApiClient(ApiClient apiClient) {
    *
    * <p>See {@link #createRetentionFilterWithHttpInfo}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param body The definition of the new RUM retention filter. (required)
    * @return RumRetentionFilterResponse
    * @throws ApiException if fails to make API call
@@ -68,7 +68,7 @@ public RumRetentionFilterResponse createRetentionFilter(
    *
    * <p>See {@link #createRetentionFilterWithHttpInfoAsync}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param body The definition of the new RUM retention filter. (required)
    * @return CompletableFuture&lt;RumRetentionFilterResponse&gt;
    */
@@ -82,10 +82,10 @@ public CompletableFuture<RumRetentionFilterResponse> createRetentionFilterAsync(
   }
 
   /**
-   * Create a RUM retention filter for an application. Returns RUM retention filter objects from the
-   * request body when the request is successful.
+   * Create a RUM retention filter for a RUM application. Returns RUM retention filter objects from
+   * the request body when the request is successful.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param body The definition of the new RUM retention filter. (required)
    * @return ApiResponse&lt;RumRetentionFilterResponse&gt;
    * @throws ApiException if fails to make API call
@@ -146,7 +146,7 @@ public ApiResponse<RumRetentionFilterResponse> createRetentionFilterWithHttpInfo
    *
    * <p>See {@link #createRetentionFilterWithHttpInfo}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param body The definition of the new RUM retention filter. (required)
    * @return CompletableFuture&lt;ApiResponse&lt;RumRetentionFilterResponse&gt;&gt;
    */
@@ -210,7 +210,7 @@ public ApiResponse<RumRetentionFilterResponse> createRetentionFilterWithHttpInfo
    *
    * <p>See {@link #deleteRetentionFilterWithHttpInfo}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param rfId Retention filter ID. (required)
    * @throws ApiException if fails to make API call
    */
@@ -223,7 +223,7 @@ public void deleteRetentionFilter(String appId, String rfId) throws ApiException
    *
    * <p>See {@link #deleteRetentionFilterWithHttpInfoAsync}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param rfId Retention filter ID. (required)
    * @return CompletableFuture
    */
@@ -236,9 +236,9 @@ public CompletableFuture<Void> deleteRetentionFilterAsync(String appId, String r
   }
 
   /**
-   * Delete a RUM retention filter for an application.
+   * Delete a RUM retention filter for a RUM application.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param rfId Retention filter ID. (required)
    * @return ApiResponse&lt;Void&gt;
    * @throws ApiException if fails to make API call
@@ -300,7 +300,7 @@ public ApiResponse<Void> deleteRetentionFilterWithHttpInfo(String appId, String
    *
    * <p>See {@link #deleteRetentionFilterWithHttpInfo}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param rfId Retention filter ID. (required)
    * @return CompletableFuture&lt;ApiResponse&lt;Void&gt;&gt;
    */
@@ -365,7 +365,7 @@ public CompletableFuture<ApiResponse<Void>> deleteRetentionFilterWithHttpInfoAsy
    *
    * <p>See {@link #getRetentionFilterWithHttpInfo}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param rfId Retention filter ID. (required)
    * @return RumRetentionFilterResponse
    * @throws ApiException if fails to make API call
@@ -380,7 +380,7 @@ public RumRetentionFilterResponse getRetentionFilter(String appId, String rfId)
    *
    * <p>See {@link #getRetentionFilterWithHttpInfoAsync}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param rfId Retention filter ID. (required)
    * @return CompletableFuture&lt;RumRetentionFilterResponse&gt;
    */
@@ -394,9 +394,9 @@ public CompletableFuture<RumRetentionFilterResponse> getRetentionFilterAsync(
   }
 
   /**
-   * Get a RUM retention filter for an application.
+   * Get a RUM retention filter for a RUM application.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param rfId Retention filter ID. (required)
    * @return ApiResponse&lt;RumRetentionFilterResponse&gt;
    * @throws ApiException if fails to make API call
@@ -458,7 +458,7 @@ public ApiResponse<RumRetentionFilterResponse> getRetentionFilterWithHttpInfo(
    *
    * <p>See {@link #getRetentionFilterWithHttpInfo}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param rfId Retention filter ID. (required)
    * @return CompletableFuture&lt;ApiResponse&lt;RumRetentionFilterResponse&gt;&gt;
    */
@@ -523,7 +523,7 @@ public ApiResponse<RumRetentionFilterResponse> getRetentionFilterWithHttpInfo(
    *
    * <p>See {@link #listRetentionFiltersWithHttpInfo}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @return RumRetentionFiltersResponse
    * @throws ApiException if fails to make API call
    */
@@ -536,7 +536,7 @@ public RumRetentionFiltersResponse listRetentionFilters(String appId) throws Api
    *
    * <p>See {@link #listRetentionFiltersWithHttpInfoAsync}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @return CompletableFuture&lt;RumRetentionFiltersResponse&gt;
    */
   public CompletableFuture<RumRetentionFiltersResponse> listRetentionFiltersAsync(String appId) {
@@ -548,9 +548,9 @@ public CompletableFuture<RumRetentionFiltersResponse> listRetentionFiltersAsync(
   }
 
   /**
-   * Get the list of RUM retention filters for an application.
+   * Get the list of RUM retention filters for a RUM application.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @return ApiResponse&lt;RumRetentionFiltersResponse&gt;
    * @throws ApiException if fails to make API call
    * @http.response.details
@@ -603,7 +603,7 @@ public ApiResponse<RumRetentionFiltersResponse> listRetentionFiltersWithHttpInfo
    *
    * <p>See {@link #listRetentionFiltersWithHttpInfo}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @return CompletableFuture&lt;ApiResponse&lt;RumRetentionFiltersResponse&gt;&gt;
    */
   public CompletableFuture<ApiResponse<RumRetentionFiltersResponse>>
@@ -659,7 +659,7 @@ public ApiResponse<RumRetentionFiltersResponse> listRetentionFiltersWithHttpInfo
    *
    * <p>See {@link #orderRetentionFiltersWithHttpInfo}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param body New definition of the RUM retention filter. (required)
    * @return RumRetentionFiltersOrderResponse
    * @throws ApiException if fails to make API call
@@ -674,7 +674,7 @@ public RumRetentionFiltersOrderResponse orderRetentionFilters(
    *
    * <p>See {@link #orderRetentionFiltersWithHttpInfoAsync}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param body New definition of the RUM retention filter. (required)
    * @return CompletableFuture&lt;RumRetentionFiltersOrderResponse&gt;
    */
@@ -688,10 +688,10 @@ public CompletableFuture<RumRetentionFiltersOrderResponse> orderRetentionFilters
   }
 
   /**
-   * Order RUM retention filters for an application. Returns RUM retention filter objects without
+   * 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 appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param body New definition of the RUM retention filter. (required)
    * @return ApiResponse&lt;RumRetentionFiltersOrderResponse&gt;
    * @throws ApiException if fails to make API call
@@ -752,7 +752,7 @@ public ApiResponse<RumRetentionFiltersOrderResponse> orderRetentionFiltersWithHt
    *
    * <p>See {@link #orderRetentionFiltersWithHttpInfo}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param body New definition of the RUM retention filter. (required)
    * @return CompletableFuture&lt;ApiResponse&lt;RumRetentionFiltersOrderResponse&gt;&gt;
    */
@@ -819,7 +819,7 @@ public ApiResponse<RumRetentionFiltersOrderResponse> orderRetentionFiltersWithHt
    *
    * <p>See {@link #updateRetentionFilterWithHttpInfo}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param rfId Retention filter ID. (required)
    * @param body New definition of the RUM retention filter. (required)
    * @return RumRetentionFilterResponse
@@ -835,7 +835,7 @@ public RumRetentionFilterResponse updateRetentionFilter(
    *
    * <p>See {@link #updateRetentionFilterWithHttpInfoAsync}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param rfId Retention filter ID. (required)
    * @param body New definition of the RUM retention filter. (required)
    * @return CompletableFuture&lt;RumRetentionFilterResponse&gt;
@@ -850,10 +850,10 @@ public CompletableFuture<RumRetentionFilterResponse> updateRetentionFilterAsync(
   }
 
   /**
-   * Update a RUM retention filter for an application. Returns RUM retention filter objects from the
-   * request body when the request is successful.
+   * Update a RUM retention filter for a RUM application. Returns RUM retention filter objects from
+   * the request body when the request is successful.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param rfId Retention filter ID. (required)
    * @param body New definition of the RUM retention filter. (required)
    * @return ApiResponse&lt;RumRetentionFilterResponse&gt;
@@ -923,7 +923,7 @@ public ApiResponse<RumRetentionFilterResponse> updateRetentionFilterWithHttpInfo
    *
    * <p>See {@link #updateRetentionFilterWithHttpInfo}.
    *
-   * @param appId Application ID. (required)
+   * @param appId RUM application ID. (required)
    * @param rfId Retention filter ID. (required)
    * @param body New definition of the RUM retention filter. (required)
    * @return CompletableFuture&lt;ApiResponse&lt;RumRetentionFilterResponse&gt;&gt;

src/main/java/com/datadog/api/client/v2/model/RumRetentionFilterMeta.java

@@ -32,7 +32,8 @@ public RumRetentionFilterMeta source(RumRetentionFilterSource source) {
   }
 
   /**
-   * 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.
    *
    * @return source
    */

src/main/java/com/datadog/api/client/v2/model/RumRetentionFilterSource.java

@@ -18,7 +18,10 @@
 import java.util.HashSet;
 import java.util.Set;
 
-/** 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.
+ */
 @JsonSerialize(using = RumRetentionFilterSource.RumRetentionFilterSourceSerializer.class)
 public class RumRetentionFilterSource extends ModelEnum<String> {
 

src/main/java/com/datadog/api/client/v2/model/RumRetentionFiltersOrderRequest.java

@@ -20,7 +20,7 @@
 
 /**
  * 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.
+ * retention filter IDs should be included in the list created for a RUM application.
  */
 @JsonPropertyOrder({RumRetentionFiltersOrderRequest.JSON_PROPERTY_DATA})
 @jakarta.annotation.Generated(

src/main/java/com/datadog/api/client/v2/model/RumRetentionFiltersResponse.java

@@ -18,7 +18,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** All RUM retention filters for an application. */
+/** All RUM retention filters for a RUM application. */
 @JsonPropertyOrder({RumRetentionFiltersResponse.JSON_PROPERTY_DATA})
 @jakarta.annotation.Generated(
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")