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

Co-authored-by: ci.datadog-api-spec <[email protected]>
DataDog · Nov 4, 2024 · f06c759 · f06c759
1 parent 2c1eb53
commit f06c759
Show file tree

Hide file tree

Showing 13 changed files with 41 additions and 36 deletions.
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:48.645471",
-            "spec_repo_commit": "82ea89c4"
+            "regenerated": "2024-11-04 20:35:51.742612",
+            "spec_repo_commit": "0a78d630"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-11-04 19:34:48.664639",
-            "spec_repo_commit": "82ea89c4"
+            "regenerated": "2024-11-04 20:35:51.761313",
+            "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/packages/datadog-api-client-v2/models/RumMetricCompute.ts b/packages/datadog-api-client-v2/models/RumMetricCompute.ts
@@ -17,11 +17,12 @@ export class RumMetricCompute {
   "aggregationType": RumMetricComputeAggregationType;
   /**
    * 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`.
    */
   "includePercentiles"?: boolean;
   /**
-   * 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 `aggregation_type` is `distribution`.
    */
   "path"?: string;
 

diff --git a/packages/datadog-api-client-v2/models/RumMetricCreateAttributes.ts b/packages/datadog-api-client-v2/models/RumMetricCreateAttributes.ts
@@ -32,7 +32,7 @@ export class RumMetricCreateAttributes {
    */
   "groupBy"?: Array<RumMetricGroupBy>;
   /**
-   * 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 `sessions` or `views`.
    */
   "uniqueness"?: RumMetricUniqueness;
 

diff --git a/packages/datadog-api-client-v2/models/RumMetricFilter.ts b/packages/datadog-api-client-v2/models/RumMetricFilter.ts
@@ -11,7 +11,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
  */
 export class RumMetricFilter {
   /**
-   * The search query - following the RUM search syntax. Must include an @type facet query.
+   * The search query - following the RUM search syntax.
    */
   "query": string;
 

diff --git a/packages/datadog-api-client-v2/models/RumMetricGroupBy.ts b/packages/datadog-api-client-v2/models/RumMetricGroupBy.ts
@@ -15,7 +15,7 @@ export class RumMetricGroupBy {
    */
   "path": string;
   /**
-   * Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
+   * Eventual name of the tag that gets created. By default, `path` is used as the tag name.
    */
   "tagName"?: string;
 

diff --git a/packages/datadog-api-client-v2/models/RumMetricResponseAttributes.ts b/packages/datadog-api-client-v2/models/RumMetricResponseAttributes.ts
@@ -32,7 +32,7 @@ export class RumMetricResponseAttributes {
    */
   "groupBy"?: Array<RumMetricResponseGroupBy>;
   /**
-   * 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`.
    */
   "uniqueness"?: RumMetricResponseUniqueness;
 

diff --git a/packages/datadog-api-client-v2/models/RumMetricResponseCompute.ts b/packages/datadog-api-client-v2/models/RumMetricResponseCompute.ts
@@ -17,11 +17,12 @@ export class RumMetricResponseCompute {
   "aggregationType"?: RumMetricComputeAggregationType;
   /**
    * 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`.
    */
   "includePercentiles"?: boolean;
   /**
-   * 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 `aggregation_type` is `distribution`.
    */
   "path"?: string;
 

diff --git a/packages/datadog-api-client-v2/models/RumMetricResponseGroupBy.ts b/packages/datadog-api-client-v2/models/RumMetricResponseGroupBy.ts
@@ -15,7 +15,7 @@ export class RumMetricResponseGroupBy {
    */
   "path"?: string;
   /**
-   * Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
+   * Eventual name of the tag that gets created. By default, `path` is used as the tag name.
    */
   "tagName"?: string;
 

diff --git a/packages/datadog-api-client-v2/models/RumMetricResponseUniqueness.ts b/packages/datadog-api-client-v2/models/RumMetricResponseUniqueness.ts
@@ -8,11 +8,11 @@ import { RumMetricUniquenessWhen } from "./RumMetricUniquenessWhen";
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
 /**
- * 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`.
  */
 export class RumMetricResponseUniqueness {
   /**
-   * When to count updatable events. "match" when the event is first seen, or "end" when the event is complete.
+   * When to count updatable events. `match` when the event is first seen, or `end` when the event is complete.
    */
   "when"?: RumMetricUniquenessWhen;
 

diff --git a/packages/datadog-api-client-v2/models/RumMetricUniqueness.ts b/packages/datadog-api-client-v2/models/RumMetricUniqueness.ts
@@ -8,11 +8,11 @@ import { RumMetricUniquenessWhen } from "./RumMetricUniquenessWhen";
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
 /**
- * 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 `sessions` or `views`.
  */
 export class RumMetricUniqueness {
   /**
-   * When to count updatable events. "match" when the event is first seen, or "end" when the event is complete.
+   * When to count updatable events. `match` when the event is first seen, or `end` when the event is complete.
    */
   "when": RumMetricUniquenessWhen;
 

diff --git a/packages/datadog-api-client-v2/models/RumMetricUniquenessWhen.ts b/packages/datadog-api-client-v2/models/RumMetricUniquenessWhen.ts
@@ -7,7 +7,7 @@
 import { UnparsedObject } from "../../datadog-api-client-common/util";
 
 /**
- * When to count updatable events. "match" when the event is first seen, or "end" when the event is complete.
+ * When to count updatable events. `match` when the event is first seen, or `end` when the event is complete.
  */
 
 export type RumMetricUniquenessWhen =

diff --git a/packages/datadog-api-client-v2/models/RumMetricUpdateCompute.ts b/packages/datadog-api-client-v2/models/RumMetricUpdateCompute.ts
@@ -12,7 +12,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 export class RumMetricUpdateCompute {
   /**
    * 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`.
    */
   "includePercentiles"?: boolean;