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

Co-authored-by: ci.datadog-api-spec <[email protected]>

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-11-04 19:34:43.057948",
-            "spec_repo_commit": "82ea89c4"
+            "regenerated": "2024-11-04 20:35:53.754475",
+            "spec_repo_commit": "0a78d630"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-11-04 19:34:43.103441",
-            "spec_repo_commit": "82ea89c4"
+            "regenerated": "2024-11-04 20:35:53.773064",
+            "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/main/java/com/datadog/api/client/v2/model/RumMetricCompute.java

@@ -77,7 +77,7 @@ public RumMetricCompute includePercentiles(Boolean includePercentiles) {
 
   /**
    * Toggle to include or exclude percentile aggregations for distribution metrics. Only present
-   * when the <code>aggregation_type</code> is <code>distribution</code>.
+   * when <code>aggregation_type</code> is <code>distribution</code>.
    *
    * @return includePercentiles
    */
@@ -98,8 +98,8 @@ public RumMetricCompute path(String path) {
   }
 
   /**
-   * The path to the value the rum-based metric will aggregate on (only used if the aggregation type
-   * is a "distribution").
+   * The path to the value the rum-based metric will aggregate on. Only present when <code>
+   * aggregation_type</code> is <code>distribution</code>.
    *
    * @return path
    */

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

@@ -166,7 +166,8 @@ public RumMetricCreateAttributes uniqueness(RumMetricUniqueness uniqueness) {
   }
 
   /**
-   * 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 <code>event_type</code> is <code>sessions
+   * </code> or <code>views</code>.
    *
    * @return uniqueness
    */

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

@@ -39,7 +39,7 @@ public RumMetricFilter query(String query) {
   }
 
   /**
-   * The search query - following the RUM search syntax. Must include an @type facet query.
+   * The search query - following the RUM search syntax.
    *
    * @return query
    */

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

@@ -62,7 +62,7 @@ public RumMetricGroupBy tagName(String tagName) {
   }
 
   /**
-   * Eventual name of the tag that gets created. By default, the path attribute is used as the tag
+   * Eventual name of the tag that gets created. By default, <code>path</code> is used as the tag
    * name.
    *
    * @return tagName

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

@@ -154,7 +154,8 @@ public RumMetricResponseAttributes uniqueness(RumMetricResponseUniqueness unique
   }
 
   /**
-   * 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 <code>event_type</code> is <code>session
+   * </code> or <code>view</code>.
    *
    * @return uniqueness
    */

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

@@ -67,7 +67,7 @@ public RumMetricResponseCompute includePercentiles(Boolean includePercentiles) {
 
   /**
    * Toggle to include or exclude percentile aggregations for distribution metrics. Only present
-   * when the <code>aggregation_type</code> is <code>distribution</code>.
+   * when <code>aggregation_type</code> is <code>distribution</code>.
    *
    * @return includePercentiles
    */
@@ -88,8 +88,8 @@ public RumMetricResponseCompute path(String path) {
   }
 
   /**
-   * The path to the value the rum-based metric will aggregate on (only used if the aggregation type
-   * is a "distribution").
+   * The path to the value the rum-based metric will aggregate on. Only present when <code>
+   * aggregation_type</code> is <code>distribution</code>.
    *
    * @return path
    */

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

@@ -58,7 +58,7 @@ public RumMetricResponseGroupBy tagName(String tagName) {
   }
 
   /**
-   * Eventual name of the tag that gets created. By default, the path attribute is used as the tag
+   * Eventual name of the tag that gets created. By default, <code>path</code> is used as the tag
    * name.
    *
    * @return tagName

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

@@ -16,7 +16,10 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** 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 <code>event_type</code> is <code>session
+ * </code> or <code>view</code>.
+ */
 @JsonPropertyOrder({RumMetricResponseUniqueness.JSON_PROPERTY_WHEN})
 @jakarta.annotation.Generated(
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -32,8 +35,8 @@ public RumMetricResponseUniqueness when(RumMetricUniquenessWhen when) {
   }
 
   /**
-   * When to count updatable events. "match" when the event is first seen, or "end" when the event
-   * is complete.
+   * When to count updatable events. <code>match</code> when the event is first seen, or <code>end
+   * </code> when the event is complete.
    *
    * @return when
    */

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

@@ -17,7 +17,10 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** 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 <code>event_type</code> is <code>sessions
+ * </code> or <code>views</code>.
+ */
 @JsonPropertyOrder({RumMetricUniqueness.JSON_PROPERTY_WHEN})
 @jakarta.annotation.Generated(
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -42,8 +45,8 @@ public RumMetricUniqueness when(RumMetricUniquenessWhen when) {
   }
 
   /**
-   * When to count updatable events. "match" when the event is first seen, or "end" when the event
-   * is complete.
+   * When to count updatable events. <code>match</code> when the event is first seen, or <code>end
+   * </code> when the event is complete.
    *
    * @return when
    */

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

@@ -19,8 +19,8 @@
 import java.util.Set;
 
 /**
- * When to count updatable events. "match" when the event is first seen, or "end" when the event is
- * complete.
+ * When to count updatable events. <code>match</code> when the event is first seen, or <code>end
+ * </code> when the event is complete.
  */
 @JsonSerialize(using = RumMetricUniquenessWhen.RumMetricUniquenessWhenSerializer.class)
 public class RumMetricUniquenessWhen extends ModelEnum<String> {

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

@@ -32,7 +32,7 @@ public RumMetricUpdateCompute includePercentiles(Boolean includePercentiles) {
 
   /**
    * Toggle to include or exclude percentile aggregations for distribution metrics. Only present
-   * when the <code>aggregation_type</code> is <code>distribution</code>.
+   * when <code>aggregation_type</code> is <code>distribution</code>.
    *
    * @return includePercentiles
    */