RUM - simplify cross-product sampling descriptions on rum-retention-filters API docs (DataDog#3785)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit b5263238b76c · 2026-03-12T09:36:54.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -54741,43 +54741,33 @@ components:
       x-enum-varnames:
       - RULESET
     RumCrossProductSampling:
-      description: 'Configuration for additional APM trace data retention for sessions
-        that match this retention filter.
-
-        When a session matches the filter and is retained (based on `sample_rate`),
-        you can configure
-
-        the percentage of retained sessions with ingested traces whose traces are
-        indexed.'
+      description: The configuration for cross-product retention filters.
       properties:
         trace_enabled:
-          description: Indicates whether trace cross-product sampling is enabled.
-            If `false`, no traces are indexed regardless of `trace_sample_rate`.
+          description: Whether the cross-product retention filter for APM traces is
+            enabled.
           example: true
           type: boolean
         trace_sample_rate:
-          description: 'The percentage (0-100) of retained sessions with ingested
-            traces whose traces are indexed.
-
-            For example, 25.0 means 25% of retained sessions with ingested traces
-            have their traces indexed.'
+          description: The sample rate for the APM cross-product retention filter,
+            between 0 and 100.
           example: 25.0
           format: double
           maximum: 100
           minimum: 0
           type: number
       type: object
     RumCrossProductSamplingCreate:
-      description: Configuration for cross-product sampling when creating a retention
-        filter.
+      description: The configuration for cross-product retention filters.
       properties:
         trace_enabled:
-          description: Indicates whether trace cross-product sampling is enabled.
+          description: Whether the cross-product retention filter for APM traces is
+            enabled.
           example: true
           type: boolean
         trace_sample_rate:
-          description: The percentage (0-100) of retained sessions with ingested traces
-            whose traces are indexed.
+          description: The sample rate for the APM cross-product retention filter,
+            between 0 and 100.
           example: 25.0
           format: double
           maximum: 100
@@ -54787,16 +54777,17 @@ components:
       - trace_sample_rate
       type: object
     RumCrossProductSamplingUpdate:
-      description: Configuration for cross-product sampling when updating a retention
-        filter. All fields are optional for partial updates.
+      description: The configuration for cross-product retention filters. All fields
+        are optional for partial updates.
       properties:
         trace_enabled:
-          description: Indicates whether trace cross-product sampling is enabled.
+          description: Whether the cross-product retention filter for APM traces is
+            enabled.
           example: true
           type: boolean
         trace_sample_rate:
-          description: The percentage (0-100) of retained sessions with ingested traces
-            whose traces are indexed.
+          description: The sample rate for the APM cross-product retention filter,
+            between 0 and 100.
           example: 25.0
           format: double
           maximum: 100
diff --git a/api/datadogV2/model_rum_cross_product_sampling.go b/api/datadogV2/model_rum_cross_product_sampling.go
@@ -8,14 +8,11 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// RumCrossProductSampling Configuration for additional APM trace data retention for sessions that match this retention filter.
-// When a session matches the filter and is retained (based on `sample_rate`), you can configure
-// the percentage of retained sessions with ingested traces whose traces are indexed.
+// RumCrossProductSampling The configuration for cross-product retention filters.
 type RumCrossProductSampling struct {
-	// Indicates whether trace cross-product sampling is enabled. If `false`, no traces are indexed regardless of `trace_sample_rate`.
+	// Whether the cross-product retention filter for APM traces is enabled.
 	TraceEnabled *bool `json:"trace_enabled,omitempty"`
-	// The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
-	// For example, 25.0 means 25% of retained sessions with ingested traces have their traces indexed.
+	// The sample rate for the APM cross-product retention filter, between 0 and 100.
 	TraceSampleRate *float64 `json:"trace_sample_rate,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`
diff --git a/api/datadogV2/model_rum_cross_product_sampling_create.go b/api/datadogV2/model_rum_cross_product_sampling_create.go
@@ -10,11 +10,11 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// RumCrossProductSamplingCreate Configuration for cross-product sampling when creating a retention filter.
+// RumCrossProductSamplingCreate The configuration for cross-product retention filters.
 type RumCrossProductSamplingCreate struct {
-	// Indicates whether trace cross-product sampling is enabled.
+	// Whether the cross-product retention filter for APM traces is enabled.
 	TraceEnabled *bool `json:"trace_enabled,omitempty"`
-	// The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
+	// The sample rate for the APM cross-product retention filter, between 0 and 100.
 	TraceSampleRate float64 `json:"trace_sample_rate"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`
diff --git a/api/datadogV2/model_rum_cross_product_sampling_update.go b/api/datadogV2/model_rum_cross_product_sampling_update.go
@@ -8,11 +8,11 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// RumCrossProductSamplingUpdate Configuration for cross-product sampling when updating a retention filter. All fields are optional for partial updates.
+// RumCrossProductSamplingUpdate The configuration for cross-product retention filters. All fields are optional for partial updates.
 type RumCrossProductSamplingUpdate struct {
-	// Indicates whether trace cross-product sampling is enabled.
+	// Whether the cross-product retention filter for APM traces is enabled.
 	TraceEnabled *bool `json:"trace_enabled,omitempty"`
-	// The percentage (0-100) of retained sessions with ingested traces whose traces are indexed.
+	// The sample rate for the APM cross-product retention filter, between 0 and 100.
 	TraceSampleRate *float64 `json:"trace_sample_rate,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`
diff --git a/api/datadogV2/model_rum_retention_filter_attributes.go b/api/datadogV2/model_rum_retention_filter_attributes.go
@@ -10,9 +10,7 @@ import (
 
 // RumRetentionFilterAttributes The object describing attributes of a RUM retention filter.
 type RumRetentionFilterAttributes struct {
-	// Configuration for additional APM trace data retention for sessions that match this retention filter.
-	// When a session matches the filter and is retained (based on `sample_rate`), you can configure
-	// the percentage of retained sessions with ingested traces whose traces are indexed.
+	// The configuration for cross-product retention filters.
 	CrossProductSampling *RumCrossProductSampling `json:"cross_product_sampling,omitempty"`
 	// Whether the retention filter is enabled.
 	Enabled *bool `json:"enabled,omitempty"`
diff --git a/api/datadogV2/model_rum_retention_filter_create_attributes.go b/api/datadogV2/model_rum_retention_filter_create_attributes.go
@@ -12,7 +12,7 @@ import (
 
 // RumRetentionFilterCreateAttributes The object describing attributes of a RUM retention filter to create.
 type RumRetentionFilterCreateAttributes struct {
-	// Configuration for cross-product sampling when creating a retention filter.
+	// The configuration for cross-product retention filters.
 	CrossProductSampling *RumCrossProductSamplingCreate `json:"cross_product_sampling,omitempty"`
 	// Whether the retention filter is enabled.
 	Enabled *bool `json:"enabled,omitempty"`
diff --git a/api/datadogV2/model_rum_retention_filter_update_attributes.go b/api/datadogV2/model_rum_retention_filter_update_attributes.go
@@ -10,7 +10,7 @@ import (
 
 // RumRetentionFilterUpdateAttributes The object describing attributes of a RUM retention filter to update.
 type RumRetentionFilterUpdateAttributes struct {
-	// Configuration for cross-product sampling when updating a retention filter. All fields are optional for partial updates.
+	// The configuration for cross-product retention filters. All fields are optional for partial updates.
 	CrossProductSampling *RumCrossProductSamplingUpdate `json:"cross_product_sampling,omitempty"`
 	// Whether the retention filter is enabled.
 	Enabled *bool `json:"enabled,omitempty"`
