diff --git a/.apigentools-info b/.apigentools-info index 50e0dfce9c3..1b7fb983b29 100644 --- 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" } } } \ No newline at end of file diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 4dac73fbf3e..9f80c2b5d5d 100644 --- 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,8 +19510,8 @@ 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' @@ -19516,8 +19519,8 @@ components: - 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 index e0db03e42a7..57c7c8b7fec 100644 --- 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 index f61fc53b97b..8716ce18fcd 100644 --- 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; /** - * 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 index 2f82a7eb949..44116bb1e3b 100644 --- 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 index 2ed0e6db1b1..1473f6eb102 100644 --- 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 index c2f7abcf9a0..09ed98ebe56 100644 --- 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; /** - * 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 index e99b13bef4c..f789f9ec42a 100644 --- 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 index f1623845d70..e0058360b33 100644 --- 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 index 3004794f9f7..ae5aeb89713 100644 --- 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 index 558510b3e18..3663349d571 100644 --- 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 index 2ee2646dae7..13365f8353b 100644 --- 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 index 940a7e8fe04..5e6757f8753 100644 --- 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;