Skip to content

Commit f10d690

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

File tree

6 files changed

+33
-6
lines changed

6 files changed

+33
-6
lines changed

.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).
@@ -36338,7 +36344,9 @@ paths:
3633836344
schema:
3633936345
format: date-time
3634036346
type: string
36341-
- description: Usage type to retrieve.
36347+
- description: 'Usage type to retrieve. The following values have been **deprecated**:
36348+
36349+
`estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.'
3634236350
in: query
3634336351
name: usage_type
3634436352
required: true
@@ -36912,8 +36920,13 @@ paths:
3691236920
schema:
3691336921
format: date-time
3691436922
type: string
36915-
- description: Comma-separated list of usage types to return, or `*` for all
36923+
- description: 'Comma-separated list of usage types to return, or `*` for all
3691636924
usage types.
36925+
36926+
The following values have been **deprecated**:
36927+
36928+
`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`,
36929+
`estimated_ingested_spans_percentage`.'
3691736930
in: query
3691836931
name: fields
3691936932
required: true
@@ -36925,7 +36938,12 @@ paths:
3692536938
required: false
3692636939
schema:
3692736940
$ref: '#/components/schemas/UsageSortDirection'
36928-
- description: The field to sort by.
36941+
- description: 'The field to sort by.
36942+
36943+
The following values have been **deprecated**:
36944+
36945+
`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`,
36946+
`estimated_ingested_spans_percentage`.'
3692936947
in: query
3693036948
name: sort_name
3693136949
required: false

services/usage_metering/src/v1/UsageMeteringApi.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4744,7 +4744,8 @@ export interface UsageMeteringApiGetHourlyUsageAttributionRequest {
47444744
*/
47454745
startHr: Date;
47464746
/**
4747-
* Usage type to retrieve.
4747+
* Usage type to retrieve. The following values have been **deprecated**:
4748+
* `estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.
47484749
* @type HourlyUsageAttributionUsageType
47494750
*/
47504751
usageType: HourlyUsageAttributionUsageType;
@@ -4833,6 +4834,8 @@ export interface UsageMeteringApiGetMonthlyUsageAttributionRequest {
48334834
startMonth: Date;
48344835
/**
48354836
* Comma-separated list of usage types to return, or `*` for all usage types.
4837+
* The following values have been **deprecated**:
4838+
* `estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.
48364839
* @type MonthlyUsageAttributionSupportedMetrics
48374840
*/
48384841
fields: MonthlyUsageAttributionSupportedMetrics;
@@ -4848,6 +4851,8 @@ export interface UsageMeteringApiGetMonthlyUsageAttributionRequest {
48484851
sortDirection?: UsageSortDirection;
48494852
/**
48504853
* The field to sort by.
4854+
* The following values have been **deprecated**:
4855+
* `estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.
48514856
* @type MonthlyUsageAttributionSupportedMetrics
48524857
*/
48534858
sortName?: MonthlyUsageAttributionSupportedMetrics;

services/usage_metering/src/v1/models/HourlyUsageAttributionBody.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ export class HourlyUsageAttributionBody {
4444
"updatedAt"?: string;
4545
/**
4646
* Supported products for hourly usage attribution requests.
47+
* The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.
4748
*/
4849
"usageType"?: HourlyUsageAttributionUsageType;
4950
/**

services/usage_metering/src/v1/models/HourlyUsageAttributionUsageType.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { UnparsedObject } from "@datadog/datadog-api-client";
22

33
/**
44
* Supported products for hourly usage attribution requests.
5+
* The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.
56
*/
67
export type HourlyUsageAttributionUsageType =
78
| typeof API_USAGE

services/usage_metering/src/v1/models/MonthlyUsageAttributionBody.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ export class MonthlyUsageAttributionBody {
4040
"updatedAt"?: Date;
4141
/**
4242
* Fields in Usage Summary by tag(s).
43+
* The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.
4344
*/
4445
"values"?: MonthlyUsageAttributionValues;
4546
/**

services/usage_metering/src/v1/models/MonthlyUsageAttributionValues.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client";
22

33
/**
44
* Fields in Usage Summary by tag(s).
5+
* The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.
56
*/
67
export class MonthlyUsageAttributionValues {
78
/**

0 commit comments

Comments
 (0)