Skip to content

Update UA API docs to reflect deprecated values for estimated usage types #2453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 9, 2025
Merged

Update UA API docs to reflect deprecated values for estimated usage types #2453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-07-08 19:08:07.248096",
"spec_repo_commit": "7b042e12"
"regenerated": "2025-07-09 16:47:20.787625",
"spec_repo_commit": "d0906173"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-07-08 19:08:07.264039",
"spec_repo_commit": "7b042e12"
"regenerated": "2025-07-09 16:47:20.879372",
"spec_repo_commit": "d0906173"
}
}
}
28 changes: 23 additions & 5 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4171,7 +4171,10 @@ components:
type: array
type: object
HourlyUsageAttributionUsageType:
description: Supported products for hourly usage attribution requests.
description: 'Supported products for hourly usage attribution requests.

The following values have been **deprecated**: `estimated_indexed_spans_usage`,
`estimated_ingested_spans_usage`.'
enum:
- api_usage
- apm_fargate_usage
Expand Down Expand Up @@ -8535,7 +8538,10 @@ components:
- SCA_FARGATE_PERCENTAGE
- ALL
MonthlyUsageAttributionValues:
description: Fields in Usage Summary by tag(s).
description: 'Fields in Usage Summary by tag(s).

The following values have been **deprecated**: `estimated_indexed_spans_usage`,
`estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.'
properties:
api_percentage:
description: The percentage of synthetic API test usage by tag(s).
Expand Down Expand Up @@ -35406,7 +35412,9 @@ paths:
schema:
format: date-time
type: string
- description: Usage type to retrieve.
- description: 'Usage type to retrieve. The following values have been **deprecated**:

`estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.'
in: query
name: usage_type
required: true
Expand Down Expand Up @@ -35956,8 +35964,13 @@ paths:
schema:
format: date-time
type: string
- description: Comma-separated list of usage types to return, or `*` for all
- description: '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`.'
in: query
name: fields
required: true
Expand All @@ -35969,7 +35982,12 @@ paths:
required: false
schema:
$ref: '#/components/schemas/UsageSortDirection'
- description: The field to sort by.
- description: '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`.'
in: query
name: sort_name
required: false
Expand Down
7 changes: 6 additions & 1 deletion packages/datadog-api-client-v1/apis/UsageMeteringApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4408,7 +4408,8 @@ export interface UsageMeteringApiGetHourlyUsageAttributionRequest {
*/
startHr: Date;
/**
* Usage type to retrieve.
* Usage type to retrieve. The following values have been **deprecated**:
* `estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.
* @type HourlyUsageAttributionUsageType
*/
usageType: HourlyUsageAttributionUsageType;
Expand Down Expand Up @@ -4497,6 +4498,8 @@ export interface UsageMeteringApiGetMonthlyUsageAttributionRequest {
startMonth: Date;
/**
* 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`.
* @type MonthlyUsageAttributionSupportedMetrics
*/
fields: MonthlyUsageAttributionSupportedMetrics;
Expand All @@ -4512,6 +4515,8 @@ export interface UsageMeteringApiGetMonthlyUsageAttributionRequest {
sortDirection?: UsageSortDirection;
/**
* 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`.
* @type MonthlyUsageAttributionSupportedMetrics
*/
sortName?: MonthlyUsageAttributionSupportedMetrics;
Expand Down
1 change: 1 addition & 0 deletions packages/datadog-api-client-v1/models/HourlyUsageAttributionBody.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ export class HourlyUsageAttributionBody {
"updatedAt"?: string;
/**
* Supported products for hourly usage attribution requests.
* The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.
*/
"usageType"?: HourlyUsageAttributionUsageType;

Expand Down
1 change: 1 addition & 0 deletions packages/datadog-api-client-v1/models/HourlyUsageAttributionUsageType.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { UnparsedObject } from "../../datadog-api-client-common/util";

/**
* Supported products for hourly usage attribution requests.
* The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.
*/

export type HourlyUsageAttributionUsageType =
Expand Down
1 change: 1 addition & 0 deletions packages/datadog-api-client-v1/models/MonthlyUsageAttributionBody.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ export class MonthlyUsageAttributionBody {
"updatedAt"?: Date;
/**
* Fields in Usage Summary by tag(s).
* The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.
*/
"values"?: MonthlyUsageAttributionValues;

Expand Down
1 change: 1 addition & 0 deletions packages/datadog-api-client-v1/models/MonthlyUsageAttributionValues.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";

/**
* Fields in Usage Summary by tag(s).
* The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.
*/
export class MonthlyUsageAttributionValues {
/**
Expand Down
Loading