Skip to content

Commit af36cf6

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
Add custom cost endpoints to public API documentation (#2076)
* Regenerate client from commit bdcf730e of spec repo * pre-commit fixes --------- Co-authored-by: ci.datadog-api-spec <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent 3353871 commit af36cf6

File tree

36 files changed

+1742
-5
lines changed

36 files changed

+1742
-5
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": "2024-07-25 18:59:19.120986",
8-
"spec_repo_commit": "ccf15bee"
7+
"regenerated": "2024-07-26 15:05:43.814419",
8+
"spec_repo_commit": "bdcf730e"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-07-25 18:59:19.143047",
13-
"spec_repo_commit": "ccf15bee"
12+
"regenerated": "2024-07-26 15:05:43.831282",
13+
"spec_repo_commit": "bdcf730e"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 347 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,13 @@ components:
216216
required: true
217217
schema:
218218
type: string
219+
FileID:
220+
description: File ID.
221+
in: path
222+
name: file_id
223+
required: true
224+
schema:
225+
type: string
219226
GCPSTSServiceAccountID:
220227
description: Your GCP STS enabled service account's unique ID.
221228
in: path
@@ -5516,6 +5523,234 @@ components:
55165523
nullable: true
55175524
type: string
55185525
type: object
5526+
CustomCostGetResponseMeta:
5527+
description: Meta for the response from the Get Custom Costs endpoints.
5528+
properties:
5529+
version:
5530+
description: Version of Custom Costs file
5531+
type: string
5532+
type: object
5533+
CustomCostListResponseMeta:
5534+
description: Meta for the response from the List Custom Costs endpoints.
5535+
properties:
5536+
total_filtered_count:
5537+
description: Number of Custom Costs files returned by the List Custom Costs
5538+
endpoint
5539+
format: int64
5540+
type: integer
5541+
version:
5542+
description: Version of Custom Costs file
5543+
type: string
5544+
type: object
5545+
CustomCostUploadResponseMeta:
5546+
description: Meta for the response from the Upload Custom Costs endpoints.
5547+
properties:
5548+
version:
5549+
description: Version of Custom Costs file
5550+
type: string
5551+
type: object
5552+
CustomCostsFileGetResponse:
5553+
description: Response for Get Custom Costs files.
5554+
properties:
5555+
data:
5556+
$ref: '#/components/schemas/CustomCostsFileMetadataWithContentHighLevel'
5557+
meta:
5558+
$ref: '#/components/schemas/CustomCostGetResponseMeta'
5559+
type: object
5560+
CustomCostsFileLineItem:
5561+
description: Line item details from a Custom Costs file.
5562+
properties:
5563+
BilledCost:
5564+
description: Total cost in the cost file.
5565+
example: 100.5
5566+
format: double
5567+
type: number
5568+
BillingCurrency:
5569+
description: Currency used in the Custom Costs file.
5570+
example: USD
5571+
type: string
5572+
ChargeDescription:
5573+
description: Description for the line item cost.
5574+
example: Monthly usage charge for my service
5575+
type: string
5576+
ChargePeriodEnd:
5577+
description: End date of the usage charge.
5578+
example: '2023-02-28'
5579+
pattern: ^\d{4}-\d{2}-\d{2}$
5580+
type: string
5581+
ChargePeriodStart:
5582+
description: Start date of the usage charge.
5583+
example: '2023-02-01'
5584+
pattern: ^\d{4}-\d{2}-\d{2}$
5585+
type: string
5586+
ProviderName:
5587+
description: Name of the provider for the line item.
5588+
type: string
5589+
Tags:
5590+
additionalProperties:
5591+
type: string
5592+
description: Additional tags for the line item.
5593+
type: object
5594+
type: object
5595+
CustomCostsFileListResponse:
5596+
description: Response for List Custom Costs files.
5597+
properties:
5598+
data:
5599+
description: List of Custom Costs files.
5600+
items:
5601+
$ref: '#/components/schemas/CustomCostsFileMetadataHighLevel'
5602+
type: array
5603+
meta:
5604+
$ref: '#/components/schemas/CustomCostListResponseMeta'
5605+
type: object
5606+
CustomCostsFileMetadata:
5607+
description: Schema of a Custom Costs metadata.
5608+
properties:
5609+
billed_cost:
5610+
description: Total cost in the cost file.
5611+
example: 100.5
5612+
format: double
5613+
type: number
5614+
billing_currency:
5615+
description: Currency used in the Custom Costs file.
5616+
example: USD
5617+
type: string
5618+
charge_period:
5619+
$ref: '#/components/schemas/CustomCostsFileUsageChargePeriod'
5620+
name:
5621+
description: Name of the Custom Costs file.
5622+
example: my_file.json
5623+
type: string
5624+
provider_names:
5625+
description: Providers contained in the Custom Costs file.
5626+
items:
5627+
description: Name of the provider.
5628+
example: my_provider
5629+
type: string
5630+
type: array
5631+
status:
5632+
description: Status of the Custom Costs file.
5633+
example: active
5634+
type: string
5635+
uploaded_at:
5636+
description: Timestamp, in millisecond, of the upload time of the Custom
5637+
Costs file.
5638+
example: 1704067200000
5639+
format: double
5640+
type: number
5641+
uploaded_by:
5642+
$ref: '#/components/schemas/CustomCostsUser'
5643+
type: object
5644+
CustomCostsFileMetadataHighLevel:
5645+
description: JSON API format for a Custom Costs file.
5646+
properties:
5647+
attributes:
5648+
$ref: '#/components/schemas/CustomCostsFileMetadata'
5649+
id:
5650+
description: ID of the Custom Costs metadata.
5651+
type: string
5652+
type:
5653+
description: Type of the Custom Costs file metadata.
5654+
type: string
5655+
type: object
5656+
CustomCostsFileMetadataWithContent:
5657+
description: Schema of a cost file's metadata.
5658+
properties:
5659+
billed_cost:
5660+
description: Total cost in the cost file.
5661+
example: 100.5
5662+
format: double
5663+
type: number
5664+
billing_currency:
5665+
description: Currency used in the Custom Costs file.
5666+
example: USD
5667+
type: string
5668+
charge_period:
5669+
$ref: '#/components/schemas/CustomCostsFileUsageChargePeriod'
5670+
content:
5671+
description: Detail of the line items from the Custom Costs file.
5672+
items:
5673+
$ref: '#/components/schemas/CustomCostsFileLineItem'
5674+
type: array
5675+
name:
5676+
description: Name of the Custom Costs file.
5677+
example: my_file.json
5678+
type: string
5679+
provider_names:
5680+
description: Providers contained in the Custom Costs file.
5681+
items:
5682+
description: Name of a provider.
5683+
example: my_provider
5684+
type: string
5685+
type: array
5686+
status:
5687+
description: Status of the Custom Costs file.
5688+
example: active
5689+
type: string
5690+
uploaded_at:
5691+
description: Timestamp in millisecond of the upload time of the Custom Costs
5692+
file.
5693+
example: 1704067200000
5694+
format: double
5695+
type: number
5696+
uploaded_by:
5697+
$ref: '#/components/schemas/CustomCostsUser'
5698+
type: object
5699+
CustomCostsFileMetadataWithContentHighLevel:
5700+
description: JSON API format of for a Custom Costs file with content.
5701+
properties:
5702+
attributes:
5703+
$ref: '#/components/schemas/CustomCostsFileMetadataWithContent'
5704+
id:
5705+
description: ID of the Custom Costs metadata.
5706+
type: string
5707+
type:
5708+
description: Type of the Custom Costs file metadata.
5709+
type: string
5710+
type: object
5711+
CustomCostsFileUploadRequest:
5712+
description: Request for uploading a Custom Costs file.
5713+
items:
5714+
$ref: '#/components/schemas/CustomCostsFileLineItem'
5715+
type: array
5716+
CustomCostsFileUploadResponse:
5717+
description: Response for Uploaded Custom Costs files.
5718+
properties:
5719+
data:
5720+
$ref: '#/components/schemas/CustomCostsFileMetadataHighLevel'
5721+
meta:
5722+
$ref: '#/components/schemas/CustomCostUploadResponseMeta'
5723+
type: object
5724+
CustomCostsFileUsageChargePeriod:
5725+
description: Usage charge period of a Custom Costs file.
5726+
properties:
5727+
end:
5728+
description: End of the usage of the Custom Costs file.
5729+
example: 1706745600000
5730+
format: double
5731+
type: number
5732+
start:
5733+
description: Start of the usage of the Custom Costs file.
5734+
example: 1704067200000
5735+
format: double
5736+
type: number
5737+
type: object
5738+
CustomCostsUser:
5739+
description: Metadata of the user that has uploaded the Custom Costs file.
5740+
properties:
5741+
email:
5742+
description: The name of the Custom Costs file.
5743+
5744+
type: string
5745+
icon:
5746+
description: The name of the Custom Costs file.
5747+
example: icon.png
5748+
type: string
5749+
name:
5750+
description: Name of the user.
5751+
example: Test User
5752+
type: string
5753+
type: object
55195754
CustomDestinationAttributeTagsRestrictionListType:
55205755
default: ALLOW_LIST
55215756
description: 'How `forward_tags_restriction_list` parameter should be interpreted.
@@ -26224,6 +26459,118 @@ paths:
2622426459
summary: Update Cloud Cost Management Azure config
2622526460
tags:
2622626461
- Cloud Cost Management
26462+
/api/v2/cost/custom_costs:
26463+
get:
26464+
description: List the Custom Costs files.
26465+
operationId: ListCustomCostsFiles
26466+
responses:
26467+
'200':
26468+
content:
26469+
application/json:
26470+
schema:
26471+
$ref: '#/components/schemas/CustomCostsFileListResponse'
26472+
description: OK
26473+
'403':
26474+
content:
26475+
application/json:
26476+
schema:
26477+
$ref: '#/components/schemas/APIErrorResponse'
26478+
description: Forbidden
26479+
'429':
26480+
$ref: '#/components/responses/TooManyRequestsResponse'
26481+
security:
26482+
- apiKeyAuth: []
26483+
appKeyAuth: []
26484+
- AuthZ:
26485+
- cloud_cost_management_read
26486+
summary: List Custom Costs files
26487+
tags:
26488+
- Cloud Cost Management
26489+
put:
26490+
description: Upload a Custom Costs file.
26491+
operationId: UploadCustomCostsFile
26492+
requestBody:
26493+
content:
26494+
application/json:
26495+
schema:
26496+
$ref: '#/components/schemas/CustomCostsFileUploadRequest'
26497+
required: true
26498+
responses:
26499+
'202':
26500+
content:
26501+
application/json:
26502+
schema:
26503+
$ref: '#/components/schemas/CustomCostsFileUploadResponse'
26504+
description: Accepted
26505+
'403':
26506+
content:
26507+
application/json:
26508+
schema:
26509+
$ref: '#/components/schemas/APIErrorResponse'
26510+
description: Forbidden
26511+
'429':
26512+
$ref: '#/components/responses/TooManyRequestsResponse'
26513+
security:
26514+
- apiKeyAuth: []
26515+
appKeyAuth: []
26516+
- AuthZ:
26517+
- cloud_cost_management_write
26518+
summary: Upload Custom Costs file
26519+
tags:
26520+
- Cloud Cost Management
26521+
/api/v2/cost/custom_costs/{file_id}:
26522+
delete:
26523+
description: Delete the specified Custom Costs file.
26524+
operationId: DeleteCustomCostsFile
26525+
parameters:
26526+
- $ref: '#/components/parameters/FileID'
26527+
responses:
26528+
'204':
26529+
description: No Content
26530+
'403':
26531+
content:
26532+
application/json:
26533+
schema:
26534+
$ref: '#/components/schemas/APIErrorResponse'
26535+
description: Forbidden
26536+
'429':
26537+
$ref: '#/components/responses/TooManyRequestsResponse'
26538+
security:
26539+
- apiKeyAuth: []
26540+
appKeyAuth: []
26541+
- AuthZ:
26542+
- cloud_cost_management_write
26543+
summary: Delete Custom Costs file
26544+
tags:
26545+
- Cloud Cost Management
26546+
get:
26547+
description: Fetch the specified Custom Costs file.
26548+
operationId: GetCustomCostsFile
26549+
parameters:
26550+
- $ref: '#/components/parameters/FileID'
26551+
responses:
26552+
'200':
26553+
content:
26554+
application/json:
26555+
schema:
26556+
$ref: '#/components/schemas/CustomCostsFileGetResponse'
26557+
description: OK
26558+
'403':
26559+
content:
26560+
application/json:
26561+
schema:
26562+
$ref: '#/components/schemas/APIErrorResponse'
26563+
description: Forbidden
26564+
'429':
26565+
$ref: '#/components/responses/TooManyRequestsResponse'
26566+
security:
26567+
- apiKeyAuth: []
26568+
appKeyAuth: []
26569+
- AuthZ:
26570+
- cloud_cost_management_read
26571+
summary: Get Custom Costs file
26572+
tags:
26573+
- Cloud Cost Management
2622726574
/api/v2/cost/enabled:
2622826575
get:
2622926576
description: Get the Cloud Cost Management activity.

0 commit comments

Comments
 (0)