Skip to content

Commit c9c0714

Browse files
feat: update API specifications (#101)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent f282825 commit c9c0714

File tree

1 file changed

+70
-2
lines changed

1 file changed

+70
-2
lines changed

openapi.yml

Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1203,6 +1203,29 @@ paths:
12031203
$ref: '#/components/responses/project_unauthorized'
12041204
'404':
12051205
$ref: '#/components/responses/project_not_found'
1206+
/v1/projects/{project_id}/billing/fields:
1207+
description: View billing fields for a given time period
1208+
get:
1209+
summary: List Project Billing Fields
1210+
tags:
1211+
- Management API
1212+
security:
1213+
- ApiKeyAuth: []
1214+
operationId: listProjectBillingFields
1215+
description: Lists the accessors, deployment types, tags, and line items used for billing data in the specified time period. Use this endpoint if you want to filter your results from the Billing Breakdown endpoint and want to know what filters are available.
1216+
parameters:
1217+
- $ref: '#/components/parameters/project_id'
1218+
- $ref: '#/components/parameters/start_date'
1219+
- $ref: '#/components/parameters/end_date'
1220+
responses:
1221+
'200':
1222+
$ref: '#/components/responses/billing_fields'
1223+
'400':
1224+
$ref: '#/components/responses/projects_bad_request'
1225+
'401':
1226+
$ref: '#/components/responses/project_unauthorized'
1227+
'404':
1228+
$ref: '#/components/responses/project_not_found'
12061229
/v1/projects/{project_id}/purchases:
12071230
description: Manage your project purchases
12081231
get:
@@ -3914,8 +3937,8 @@ components:
39143937
items:
39153938
type: string
39163939
example:
3917-
- tag=dev
3918-
- tag=production
3940+
- dev
3941+
- production
39193942
models:
39203943
type: array
39213944
description: List of models available for the project.
@@ -4170,6 +4193,51 @@ components:
41704193
example:
41714194
- tag1
41724195
- tag2
4196+
billing_fields:
4197+
description: A list of billing fields for a specific project
4198+
content:
4199+
application/json:
4200+
schema:
4201+
type: object
4202+
properties:
4203+
accessors:
4204+
type: array
4205+
description: List of accessor UUIDs for the time period
4206+
items:
4207+
type: string
4208+
format: uuid
4209+
example:
4210+
- 12345678-1234-1234-1234-123456789012
4211+
- 87654321-4321-4321-4321-210987654321
4212+
deployments:
4213+
type: array
4214+
description: List of deployment types for the time period
4215+
items:
4216+
type: string
4217+
enum:
4218+
- hosted
4219+
- beta
4220+
- self-hosted
4221+
- dedicated
4222+
example:
4223+
- hosted
4224+
- self-hosted
4225+
tags:
4226+
type: array
4227+
description: List of tags for the time period
4228+
items:
4229+
type: string
4230+
example:
4231+
- dev
4232+
- production
4233+
line_items:
4234+
type: object
4235+
description: Map of line item names to human-readable descriptions for the time period
4236+
additionalProperties:
4237+
type: string
4238+
example:
4239+
streaming::nova-3: Nova - 3 (Stream)
4240+
sync::aura-2: Aura -2 (Sync)
41734241
purchases:
41744242
description: Successful response with orders list
41754243
content:

0 commit comments

Comments
 (0)