diff --git a/.apigentools-info b/.apigentools-info index 0fe7ec82a4cb..acdfeb43f493 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:49.569743", - "spec_repo_commit": "82ea89c4" + "regenerated": "2024-11-04 20:35:45.872557", + "spec_repo_commit": "0a78d630" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2024-11-04 19:34:49.588152", - "spec_repo_commit": "82ea89c4" + "regenerated": "2024-11-04 20:35:45.891526", + "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 4dac73fbf3ee..9f80c2b5d5d0 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/lib/datadog_api_client/v2/models/rum_metric_compute.rb b/lib/datadog_api_client/v2/models/rum_metric_compute.rb index 18beae3992cd..642be0084719 100644 --- a/lib/datadog_api_client/v2/models/rum_metric_compute.rb +++ b/lib/datadog_api_client/v2/models/rum_metric_compute.rb @@ -25,10 +25,11 @@ class RumMetricCompute attr_reader :aggregation_type # 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`. attr_accessor :include_percentiles - # 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`. attr_accessor :path attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/rum_metric_create_attributes.rb b/lib/datadog_api_client/v2/models/rum_metric_create_attributes.rb index 0c6a770921e7..ea7f0e96aaaf 100644 --- a/lib/datadog_api_client/v2/models/rum_metric_create_attributes.rb +++ b/lib/datadog_api_client/v2/models/rum_metric_create_attributes.rb @@ -33,7 +33,7 @@ class RumMetricCreateAttributes # The rules for the group by. attr_accessor :group_by - # 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`. attr_accessor :uniqueness attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/rum_metric_filter.rb b/lib/datadog_api_client/v2/models/rum_metric_filter.rb index 551ac58cd98f..e56fc9b1ed45 100644 --- a/lib/datadog_api_client/v2/models/rum_metric_filter.rb +++ b/lib/datadog_api_client/v2/models/rum_metric_filter.rb @@ -21,7 +21,7 @@ module DatadogAPIClient::V2 class RumMetricFilter include BaseGenericModel - # The search query - following the RUM search syntax. Must include an @type facet query. + # The search query - following the RUM search syntax. attr_reader :query attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/rum_metric_group_by.rb b/lib/datadog_api_client/v2/models/rum_metric_group_by.rb index 15540c081de8..c049c85cfa1d 100644 --- a/lib/datadog_api_client/v2/models/rum_metric_group_by.rb +++ b/lib/datadog_api_client/v2/models/rum_metric_group_by.rb @@ -24,7 +24,7 @@ class RumMetricGroupBy # The path to the value the rum-based metric will be aggregated over. attr_reader :path - # 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. attr_accessor :tag_name attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/rum_metric_response_attributes.rb b/lib/datadog_api_client/v2/models/rum_metric_response_attributes.rb index f2167ba1dd6a..423c8467798e 100644 --- a/lib/datadog_api_client/v2/models/rum_metric_response_attributes.rb +++ b/lib/datadog_api_client/v2/models/rum_metric_response_attributes.rb @@ -33,7 +33,7 @@ class RumMetricResponseAttributes # The rules for the group by. attr_accessor :group_by - # 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`. attr_accessor :uniqueness attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/rum_metric_response_compute.rb b/lib/datadog_api_client/v2/models/rum_metric_response_compute.rb index 1414a79bf1f7..4d7c954d314b 100644 --- a/lib/datadog_api_client/v2/models/rum_metric_response_compute.rb +++ b/lib/datadog_api_client/v2/models/rum_metric_response_compute.rb @@ -25,10 +25,11 @@ class RumMetricResponseCompute attr_accessor :aggregation_type # 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`. attr_accessor :include_percentiles - # 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`. attr_accessor :path attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/rum_metric_response_group_by.rb b/lib/datadog_api_client/v2/models/rum_metric_response_group_by.rb index 9a8c16c4fff2..68c6b75fbad4 100644 --- a/lib/datadog_api_client/v2/models/rum_metric_response_group_by.rb +++ b/lib/datadog_api_client/v2/models/rum_metric_response_group_by.rb @@ -24,7 +24,7 @@ class RumMetricResponseGroupBy # The path to the value the rum-based metric will be aggregated over. attr_accessor :path - # 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. attr_accessor :tag_name attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/rum_metric_response_uniqueness.rb b/lib/datadog_api_client/v2/models/rum_metric_response_uniqueness.rb index 6eb9d4fcdd05..70384c90dfe5 100644 --- a/lib/datadog_api_client/v2/models/rum_metric_response_uniqueness.rb +++ b/lib/datadog_api_client/v2/models/rum_metric_response_uniqueness.rb @@ -17,11 +17,11 @@ require 'time' module DatadogAPIClient::V2 - # 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`. class RumMetricResponseUniqueness include BaseGenericModel - # 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. attr_accessor :_when attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/rum_metric_uniqueness.rb b/lib/datadog_api_client/v2/models/rum_metric_uniqueness.rb index d129066457d3..348f441017b7 100644 --- a/lib/datadog_api_client/v2/models/rum_metric_uniqueness.rb +++ b/lib/datadog_api_client/v2/models/rum_metric_uniqueness.rb @@ -17,11 +17,11 @@ require 'time' module DatadogAPIClient::V2 - # 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`. class RumMetricUniqueness include BaseGenericModel - # 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. attr_reader :_when attr_accessor :additional_properties diff --git a/lib/datadog_api_client/v2/models/rum_metric_uniqueness_when.rb b/lib/datadog_api_client/v2/models/rum_metric_uniqueness_when.rb index 7dd895f4a52e..9a28a997248d 100644 --- a/lib/datadog_api_client/v2/models/rum_metric_uniqueness_when.rb +++ b/lib/datadog_api_client/v2/models/rum_metric_uniqueness_when.rb @@ -17,7 +17,7 @@ require 'time' module DatadogAPIClient::V2 - # 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. class RumMetricUniquenessWhen include BaseEnumModel diff --git a/lib/datadog_api_client/v2/models/rum_metric_update_compute.rb b/lib/datadog_api_client/v2/models/rum_metric_update_compute.rb index 507e0b59a792..add462f77fb1 100644 --- a/lib/datadog_api_client/v2/models/rum_metric_update_compute.rb +++ b/lib/datadog_api_client/v2/models/rum_metric_update_compute.rb @@ -22,7 +22,7 @@ class RumMetricUpdateCompute include BaseGenericModel # 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`. attr_accessor :include_percentiles attr_accessor :additional_properties