[Rum Metrics] Fix doc issue with the API. (#2242)

* Regenerate client from commit 0a78d630 of spec repo

* pre-commit fixes

---------

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-11-04 19:34:53.527753",
-            "spec_repo_commit": "82ea89c4"
+            "regenerated": "2024-11-04 20:35:53.442516",
+            "spec_repo_commit": "0a78d630"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-11-04 19:34:53.546331",
-            "spec_repo_commit": "82ea89c4"
+            "regenerated": "2024-11-04 20:35:53.460358",
+            "spec_repo_commit": "0a78d630"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -19302,8 +19302,10 @@ components:
         include_percentiles:
           $ref: '#/components/schemas/RumMetricComputeIncludePercentiles'
         path:
-          description: The path to the value the rum-based metric will aggregate on
-            (only used if the aggregation type is a "distribution").
+          description: 'The path to the value the rum-based metric will aggregate
+            on.
+
+            Only present when `aggregation_type` is `distribution`.'
           example: '@duration'
           type: string
       required:
@@ -19323,7 +19325,7 @@ components:
       description: 'Toggle to include or exclude percentile aggregations for distribution
         metrics.
 
-        Only present when the `aggregation_type` is `distribution`.'
+        Only present when `aggregation_type` is `distribution`.'
       example: true
       type: boolean
     RumMetricCreateAttributes:
@@ -19394,8 +19396,7 @@ components:
       properties:
         query:
           default: '*'
-          description: The search query - following the RUM search syntax. Must include
-            an @type facet query.
+          description: The search query - following the RUM search syntax.
           example: '@service:web-ui: '
           type: string
       required:
@@ -19410,8 +19411,8 @@ components:
           example: '@browser.name'
           type: string
         tag_name:
-          description: Eventual name of the tag that gets created. By default, the
-            path attribute is used as the tag name.
+          description: Eventual name of the tag that gets created. By default, `path`
+            is used as the tag name.
           example: browser_name
           type: string
       required:
@@ -19452,8 +19453,10 @@ components:
         include_percentiles:
           $ref: '#/components/schemas/RumMetricComputeIncludePercentiles'
         path:
-          description: The path to the value the rum-based metric will aggregate on
-            (only used if the aggregation type is a "distribution").
+          description: 'The path to the value the rum-based metric will aggregate
+            on.
+
+            Only present when `aggregation_type` is `distribution`.'
           example: '@duration'
           type: string
       type: object
@@ -19485,14 +19488,14 @@ components:
           example: '@http.status_code'
           type: string
         tag_name:
-          description: Eventual name of the tag that gets created. By default, the
-            path attribute is used as the tag name.
+          description: Eventual name of the tag that gets created. By default, `path`
+            is used as the tag name.
           example: status_code
           type: string
       type: object
     RumMetricResponseUniqueness:
-      description: The rule to count updatable events. Is only set if "event_type"
-        is "sessions" or "views".
+      description: The rule to count updatable events. Is only set if `event_type`
+        is `session` or `view`.
       properties:
         when:
           $ref: '#/components/schemas/RumMetricUniquenessWhen'
@@ -19507,17 +19510,17 @@ components:
       x-enum-varnames:
       - RUM_METRICS
     RumMetricUniqueness:
-      description: The rule to count updatable events. Is only set if "event_type"
-        is "sessions" or "views".
+      description: The rule to count updatable events. Is only set if `event_type`
+        is `sessions` or `views`.
       properties:
         when:
           $ref: '#/components/schemas/RumMetricUniquenessWhen'
       required:
       - when
       type: object
     RumMetricUniquenessWhen:
-      description: When to count updatable events. "match" when the event is first
-        seen, or "end" when the event is complete.
+      description: When to count updatable events. `match` when the event is first
+        seen, or `end` when the event is complete.
       enum:
       - match
       - end

src/datadog_api_client/v2/model/rum_metric_compute.py

@@ -48,10 +48,11 @@ def __init__(
         :type aggregation_type: RumMetricComputeAggregationType
 
         :param include_percentiles: Toggle to include or exclude percentile aggregations for distribution metrics.
-            Only present when the ``aggregation_type`` is ``distribution``.
+            Only present when ``aggregation_type`` is ``distribution``.
         :type include_percentiles: bool, optional
 
-        :param path: The path to the value the rum-based metric will aggregate on (only used if the aggregation type is a "distribution").
+        :param path: The path to the value the rum-based metric will aggregate on.
+            Only present when ``aggregation_type`` is ``distribution``.
         :type path: str, optional
         """
         if include_percentiles is not unset:

src/datadog_api_client/v2/model/rum_metric_create_attributes.py

@@ -70,7 +70,7 @@ def __init__(
         :param group_by: The rules for the group by.
         :type group_by: [RumMetricGroupBy], optional
 
-        :param uniqueness: The rule to count updatable events. Is only set if "event_type" is "sessions" or "views".
+        :param uniqueness: The rule to count updatable events. Is only set if ``event_type`` is ``sessions`` or ``views``.
         :type uniqueness: RumMetricUniqueness, optional
         """
         if filter is not unset:

src/datadog_api_client/v2/model/rum_metric_filter.py

@@ -25,7 +25,7 @@ def __init__(self_, **kwargs):
         """
         The rum-based metric filter. Events matching this filter will be aggregated in this metric.
 
-        :param query: The search query - following the RUM search syntax. Must include an @type facet query.
+        :param query: The search query - following the RUM search syntax.
         :type query: str
         """
         super().__init__(kwargs)

src/datadog_api_client/v2/model/rum_metric_group_by.py

@@ -33,7 +33,7 @@ def __init__(self_, path: str, tag_name: Union[str, UnsetType] = unset, **kwargs
         :param path: The path to the value the rum-based metric will be aggregated over.
         :type path: str
 
-        :param tag_name: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
+        :param tag_name: Eventual name of the tag that gets created. By default, ``path`` is used as the tag name.
         :type tag_name: str, optional
         """
         if tag_name is not unset:

src/datadog_api_client/v2/model/rum_metric_response_attributes.py

@@ -70,7 +70,7 @@ def __init__(
         :param group_by: The rules for the group by.
         :type group_by: [RumMetricResponseGroupBy], optional
 
-        :param uniqueness: The rule to count updatable events. Is only set if "event_type" is "sessions" or "views".
+        :param uniqueness: The rule to count updatable events. Is only set if ``event_type`` is ``session`` or ``view``.
         :type uniqueness: RumMetricResponseUniqueness, optional
         """
         if compute is not unset:

src/datadog_api_client/v2/model/rum_metric_response_compute.py

@@ -48,10 +48,11 @@ def __init__(
         :type aggregation_type: RumMetricComputeAggregationType, optional
 
         :param include_percentiles: Toggle to include or exclude percentile aggregations for distribution metrics.
-            Only present when the ``aggregation_type`` is ``distribution``.
+            Only present when ``aggregation_type`` is ``distribution``.
         :type include_percentiles: bool, optional
 
-        :param path: The path to the value the rum-based metric will aggregate on (only used if the aggregation type is a "distribution").
+        :param path: The path to the value the rum-based metric will aggregate on.
+            Only present when ``aggregation_type`` is ``distribution``.
         :type path: str, optional
         """
         if aggregation_type is not unset:

src/datadog_api_client/v2/model/rum_metric_response_group_by.py

@@ -33,7 +33,7 @@ def __init__(self_, path: Union[str, UnsetType] = unset, tag_name: Union[str, Un
         :param path: The path to the value the rum-based metric will be aggregated over.
         :type path: str, optional
 
-        :param tag_name: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
+        :param tag_name: Eventual name of the tag that gets created. By default, ``path`` is used as the tag name.
         :type tag_name: str, optional
         """
         if path is not unset:

src/datadog_api_client/v2/model/rum_metric_response_uniqueness.py

@@ -32,9 +32,9 @@ def openapi_types(_):
 
     def __init__(self_, when: Union[RumMetricUniquenessWhen, UnsetType] = unset, **kwargs):
         """
-        The rule to count updatable events. Is only set if "event_type" is "sessions" or "views".
+        The rule to count updatable events. Is only set if ``event_type`` is ``session`` or ``view``.
 
-        :param when: When to count updatable events. "match" when the event is first seen, or "end" when the event is complete.
+        :param when: When to count updatable events. ``match`` when the event is first seen, or ``end`` when the event is complete.
         :type when: RumMetricUniquenessWhen, optional
         """
         if when is not unset: