Skip to content

Commit 03b7a28

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update UA API docs to reflect deprecated values for estimated usage types (#2509)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 24bdc56 commit 03b7a28

File tree

7 files changed

+34
-12
lines changed

7 files changed

+34
-12
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-07-08 19:08:06.298818",
8-
"spec_repo_commit": "7b042e12"
7+
"regenerated": "2025-07-09 16:47:17.991240",
8+
"spec_repo_commit": "d0906173"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-07-08 19:08:06.315210",
13-
"spec_repo_commit": "7b042e12"
12+
"regenerated": "2025-07-09 16:47:18.007275",
13+
"spec_repo_commit": "d0906173"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4171,7 +4171,10 @@ components:
41714171
type: array
41724172
type: object
41734173
HourlyUsageAttributionUsageType:
4174-
description: Supported products for hourly usage attribution requests.
4174+
description: 'Supported products for hourly usage attribution requests.
4175+
4176+
The following values have been **deprecated**: `estimated_indexed_spans_usage`,
4177+
`estimated_ingested_spans_usage`.'
41754178
enum:
41764179
- api_usage
41774180
- apm_fargate_usage
@@ -8535,7 +8538,10 @@ components:
85358538
- SCA_FARGATE_PERCENTAGE
85368539
- ALL
85378540
MonthlyUsageAttributionValues:
8538-
description: Fields in Usage Summary by tag(s).
8541+
description: 'Fields in Usage Summary by tag(s).
8542+
8543+
The following values have been **deprecated**: `estimated_indexed_spans_usage`,
8544+
`estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.'
85398545
properties:
85408546
api_percentage:
85418547
description: The percentage of synthetic API test usage by tag(s).
@@ -35406,7 +35412,9 @@ paths:
3540635412
schema:
3540735413
format: date-time
3540835414
type: string
35409-
- description: Usage type to retrieve.
35415+
- description: 'Usage type to retrieve. The following values have been **deprecated**:
35416+
35417+
`estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.'
3541035418
in: query
3541135419
name: usage_type
3541235420
required: true
@@ -35956,8 +35964,13 @@ paths:
3595635964
schema:
3595735965
format: date-time
3595835966
type: string
35959-
- description: Comma-separated list of usage types to return, or `*` for all
35967+
- description: 'Comma-separated list of usage types to return, or `*` for all
3596035968
usage types.
35969+
35970+
The following values have been **deprecated**:
35971+
35972+
`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`,
35973+
`estimated_ingested_spans_percentage`.'
3596135974
in: query
3596235975
name: fields
3596335976
required: true
@@ -35969,7 +35982,12 @@ paths:
3596935982
required: false
3597035983
schema:
3597135984
$ref: '#/components/schemas/UsageSortDirection'
35972-
- description: The field to sort by.
35985+
- description: 'The field to sort by.
35986+
35987+
The following values have been **deprecated**:
35988+
35989+
`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`,
35990+
`estimated_ingested_spans_percentage`.'
3597335991
in: query
3597435992
name: sort_name
3597535993
required: false

lib/datadog_api_client/v1/api/usage_metering_api.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ def get_hourly_usage_attribution(start_hr, usage_type, opts = {})
131131
# ```
132132
#
133133
# @param start_hr [Time] Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour.
134-
# @param usage_type [HourlyUsageAttributionUsageType] Usage type to retrieve.
134+
# @param usage_type [HourlyUsageAttributionUsageType] Usage type to retrieve. The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.
135135
# @param opts [Hash] the optional parameters
136136
# @option opts [Time] :end_hr Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour.
137137
# @option opts [String] :next_record_id List following results with a next_record_id provided in the previous query.
@@ -455,11 +455,11 @@ def get_monthly_usage_attribution(start_month, fields, opts = {})
455455
# ```
456456
#
457457
# @param start_month [Time] Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago.
458-
# @param fields [MonthlyUsageAttributionSupportedMetrics] Comma-separated list of usage types to return, or `*` for all usage types.
458+
# @param fields [MonthlyUsageAttributionSupportedMetrics] Comma-separated list of usage types to return, or `*` for all usage types. The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.
459459
# @param opts [Hash] the optional parameters
460460
# @option opts [Time] :end_month Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month.
461461
# @option opts [UsageSortDirection] :sort_direction The direction to sort by: `[desc, asc]`.
462-
# @option opts [MonthlyUsageAttributionSupportedMetrics] :sort_name The field to sort by.
462+
# @option opts [MonthlyUsageAttributionSupportedMetrics] :sort_name The field to sort by. The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.
463463
# @option opts [String] :tag_breakdown_keys Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags. To see which tags are available, look for the value of `tag_config_source` in the API response.
464464
# @option opts [String] :next_record_id List following results with a next_record_id provided in the previous query.
465465
# @option opts [Boolean] :include_descendants Include child org usage in the response. Defaults to `true`.

lib/datadog_api_client/v1/models/hourly_usage_attribution_body.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ class HourlyUsageAttributionBody
5050
attr_accessor :updated_at
5151

5252
# Supported products for hourly usage attribution requests.
53+
# The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.
5354
attr_accessor :usage_type
5455

5556
attr_accessor :additional_properties

lib/datadog_api_client/v1/models/hourly_usage_attribution_usage_type.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
module DatadogAPIClient::V1
2020
# Supported products for hourly usage attribution requests.
21+
# The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.
2122
class HourlyUsageAttributionUsageType
2223
include BaseEnumModel
2324

lib/datadog_api_client/v1/models/monthly_usage_attribution_body.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ class MonthlyUsageAttributionBody
4747
attr_accessor :updated_at
4848

4949
# Fields in Usage Summary by tag(s).
50+
# The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.
5051
attr_accessor :values
5152

5253
attr_accessor :additional_properties

lib/datadog_api_client/v1/models/monthly_usage_attribution_values.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
module DatadogAPIClient::V1
2020
# Fields in Usage Summary by tag(s).
21+
# The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.
2122
class MonthlyUsageAttributionValues
2223
include BaseGenericModel
2324

0 commit comments

Comments
 (0)