Skip to content

Reference to UsageResponse broken #33

@danielesser

Description

@danielesser

The operation getUsage references the UsageResponse schema as follows:

$ref: '#/components/schemas/UsageResponse'

Anyhow, UsageResponse is not defined under # → components → schemas, but in # → paths → /v2/usage:

openapi/openapi.yaml

Lines 1504 to 1552 in 0facea6

UsageResponse:
type: object
properties:
character_count:
description: Characters translated so far in the current billing period.
type: integer
format: int64
example: 180118
character_limit:
description: Current maximum number of characters that can be translated per billing period. If cost control is set, the cost control limit will be returned in this field.
type: integer
format: int64
example: 1250000
products:
type: array
description: Only present for API Pro users. Per-product usage details.
items:
type: object
properties:
product_type:
type: string
description: The type of product (e.g., 'write', 'translate').
example: write
api_key_character_count:
type: integer
description: Characters used for this product by this API key in the current period.
example: 0
character_count:
type: integer
description: Total characters used for this product in the current period.
example: 5643
api_key_character_count:
type: integer
description: Only present for API Pro users. Total characters used by this API key in the current period.
example: 636
api_key_character_limit:
type: integer
description: Only present for API Pro users. Character limit for this API key in the current period.
example: 1000000000000
start_time:
type: string
format: date-time
description: Only present for API Pro users. Start time of the current billing period (ISO 8601).
example: '2025-05-13T09:18:42Z'
end_time:
type: string
format: date-time
description: Only present for API Pro users. End time of the current billing period (ISO 8601).
example: '2025-06-13T09:18:42Z'

This breaks our API client generator as the reference can not be resolved. I assume either the reference needs to be changed or the response definition needs to be moved to the components section.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions