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

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit f14c7a0ddd0a · 2024-11-04T21:10:44.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.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"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.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
diff --git a/src/main/java/com/datadog/api/client/v2/model/RumMetricCompute.java b/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
    */
diff --git a/src/main/java/com/datadog/api/client/v2/model/RumMetricCreateAttributes.java b/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
    */
diff --git a/src/main/java/com/datadog/api/client/v2/model/RumMetricFilter.java b/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
    */
diff --git a/src/main/java/com/datadog/api/client/v2/model/RumMetricGroupBy.java b/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
diff --git a/src/main/java/com/datadog/api/client/v2/model/RumMetricResponseAttributes.java b/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
    */
diff --git a/src/main/java/com/datadog/api/client/v2/model/RumMetricResponseCompute.java b/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
    */
diff --git a/src/main/java/com/datadog/api/client/v2/model/RumMetricResponseGroupBy.java b/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
diff --git a/src/main/java/com/datadog/api/client/v2/model/RumMetricResponseUniqueness.java b/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
    */
diff --git a/src/main/java/com/datadog/api/client/v2/model/RumMetricUniqueness.java b/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
    */
diff --git a/src/main/java/com/datadog/api/client/v2/model/RumMetricUniquenessWhen.java b/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> {
diff --git a/src/main/java/com/datadog/api/client/v2/model/RumMetricUpdateCompute.java b/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
    */

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.6",`
`7`		`- "regenerated": "2024-11-04 19:34:43.057948",`
`8`		`- "spec_repo_commit": "82ea89c4"`
	`7`	`+ "regenerated": "2024-11-04 20:35:53.754475",`
	`8`	`+ "spec_repo_commit": "0a78d630"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2024-11-04 19:34:43.103441",`
`13`		`- "spec_repo_commit": "82ea89c4"`
	`12`	`+ "regenerated": "2024-11-04 20:35:53.773064",`
	`13`	`+ "spec_repo_commit": "0a78d630"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ public RumMetricCompute includePercentiles(Boolean includePercentiles) {`
`77`	`77`
`78`	`78`	`/**`
`79`	`79`	`* Toggle to include or exclude percentile aggregations for distribution metrics. Only present`
`80`		`- * when the <code>aggregation_type</code> is <code>distribution</code>.`
	`80`	`+ * when <code>aggregation_type</code> is <code>distribution</code>.`
`81`	`81`	`*`
`82`	`82`	`* @return includePercentiles`
`83`	`83`	`*/`
`@@ -98,8 +98,8 @@ public RumMetricCompute path(String path) {`
`98`	`98`	`}`
`99`	`99`
`100`	`100`	`/**`
`101`		`- * The path to the value the rum-based metric will aggregate on (only used if the aggregation type`
`102`		`- * is a "distribution").`
	`101`	`+ * The path to the value the rum-based metric will aggregate on. Only present when <code>`
	`102`	`+ * aggregation_type</code> is <code>distribution</code>.`
`103`	`103`	`*`
`104`	`104`	`* @return path`
`105`	`105`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,8 @@ public RumMetricCreateAttributes uniqueness(RumMetricUniqueness uniqueness) {`
`166`	`166`	`}`
`167`	`167`
`168`	`168`	`/**`
`169`		`- * The rule to count updatable events. Is only set if "event_type" is "sessions" or "views".`
	`169`	`+ * The rule to count updatable events. Is only set if <code>event_type</code> is <code>sessions`
	`170`	`+ * </code> or <code>views</code>.`
`170`	`171`	`*`
`171`	`172`	`* @return uniqueness`
`172`	`173`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public RumMetricFilter query(String query) {`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`/**`
`42`		`- * The search query - following the RUM search syntax. Must include an @type facet query.`
	`42`	`+ * The search query - following the RUM search syntax.`
`43`	`43`	`*`
`44`	`44`	`* @return query`
`45`	`45`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public RumMetricGroupBy tagName(String tagName) {`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`/**`
`65`		`- * Eventual name of the tag that gets created. By default, the path attribute is used as the tag`
	`65`	`+ * Eventual name of the tag that gets created. By default, <code>path</code> is used as the tag`
`66`	`66`	`* name.`
`67`	`67`	`*`
`68`	`68`	`* @return tagName`
Original file line number	Diff line number	Diff line change
`@@ -154,7 +154,8 @@ public RumMetricResponseAttributes uniqueness(RumMetricResponseUniqueness unique`
`154`	`154`	`}`
`155`	`155`
`156`	`156`	`/**`
`157`		`- * The rule to count updatable events. Is only set if "event_type" is "sessions" or "views".`
	`157`	`+ * The rule to count updatable events. Is only set if <code>event_type</code> is <code>session`
	`158`	`+ * </code> or <code>view</code>.`
`158`	`159`	`*`
`159`	`160`	`* @return uniqueness`
`160`	`161`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ public RumMetricResponseCompute includePercentiles(Boolean includePercentiles) {`
`67`	`67`
`68`	`68`	`/**`
`69`	`69`	`* Toggle to include or exclude percentile aggregations for distribution metrics. Only present`
`70`		`- * when the <code>aggregation_type</code> is <code>distribution</code>.`
	`70`	`+ * when <code>aggregation_type</code> is <code>distribution</code>.`
`71`	`71`	`*`
`72`	`72`	`* @return includePercentiles`
`73`	`73`	`*/`
`@@ -88,8 +88,8 @@ public RumMetricResponseCompute path(String path) {`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`/**`
`91`		`- * The path to the value the rum-based metric will aggregate on (only used if the aggregation type`
`92`		`- * is a "distribution").`
	`91`	`+ * The path to the value the rum-based metric will aggregate on. Only present when <code>`
	`92`	`+ * aggregation_type</code> is <code>distribution</code>.`
`93`	`93`	`*`
`94`	`94`	`* @return path`
`95`	`95`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public RumMetricResponseGroupBy tagName(String tagName) {`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`/**`
`61`		`- * Eventual name of the tag that gets created. By default, the path attribute is used as the tag`
	`61`	`+ * Eventual name of the tag that gets created. By default, <code>path</code> is used as the tag`
`62`	`62`	`* name.`
`63`	`63`	`*`
`64`	`64`	`* @return tagName`