Merge pull request #34 from DeepLcom/fix-usage-response-schema

daniel-jones-dev · web-flow · commit 5c548ace63da · 2025-05-27T11:33:06.000+02:00
Fix usage response schema
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,35 +10,40 @@ number is used only for corrections to the OpenAPI specification, for example:
 typos, schema fixes, or adding examples.
 
 
-### [3.1.0] - 2024-06-13
+## [3.1.1] - 2025-05-23
+### Fixed
+* Fixed incorrect placement of UsageResponse schema.
+
+
+## [3.1.0] - 2024-05-20
 ### Changed
 * `/v2/usage`: Now returns a detailed response for API Pro users, including per-product usage and billing period information. For API users not on the Pro plan, the response remains unchanged and only includes `character_count` and `character_limit`.
 
 
-### [3.0.2] - 2025-04-24
+## [3.1.0] - 2024-05-20
 ### Fixed
 * Fixed new server URLs to avoid double slash in paths
 
 
-### [3.0.1] - 2025-04-24
+## [3.0.1] - 2025-04-24
 ### Fixed
 * Fixed new server URLs to avoid double slash in paths
 
 
-### [3.0.0] - 2025-04-24
+## [3.0.0] - 2025-04-24
 ### Added
 * Add new endpoints `/v3/glossaries` which enables management of new, editable and multilingual glossaries
   * This required renaming some existing components in the spec, hence the major version upgrade. All
     functionality is backwards compatible.
 * Moved `/v2/` and `/v3/` from the Server URL into the endpoint paths, as we support multiple versions now
 
 
-### [2.18.0] - 2025-01-16
+## [2.18.0] - 2025-01-16
 ### Added
 * Add new endpoint `/write/rephrase` which enables text corrections and adjustments in selected languages
 
 
-### [2.17.0] - 2024-11-15
+## [2.17.0] - 2024-11-15
 ### Added
 * `/translate`: add `model_type` request parameter to request the model type
   (`quality_optimized`, `latency_optimized`, or `prefer_latency_optimized`) to
@@ -192,6 +197,8 @@ typos, schema fixes, or adding examples.
 Initial release of the OpenAPI specification.
 
 
+[3.1.1]: https://github.com/DeepLcom/openapi/compare/v3.1.0...v3.1.1
+[3.1.0]: https://github.com/DeepLcom/openapi/compare/v3.0.2...v3.1.0
 [3.0.2]: https://github.com/DeepLcom/openapi/compare/v3.0.1...v3.0.2
 [3.0.1]: https://github.com/DeepLcom/openapi/compare/v3.0.0...v3.0.1
 [3.0.0]: https://github.com/DeepLcom/openapi/compare/v2.18.0...v3.0.0
diff --git a/openapi.json b/openapi.json
@@ -2063,69 +2063,6 @@
             "auth_header": []
           }
         ]
-      },
-      "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"
-          }
-        }
       }
     },
     "/v2/languages": {
@@ -2986,6 +2923,69 @@
           "html"
         ]
       },
+      "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"
+          }
+        }
+      },
       "NonSplittingTagCommaSeparatedList": {
         "allOf": [
           {
diff --git a/openapi.yaml b/openapi.yaml
@@ -1501,55 +1501,6 @@ paths:
           $ref: '#/components/responses/TooManyRequests'
       security:
       - auth_header: []
-    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'
   /v2/languages:
     get:
       tags:
@@ -2421,6 +2372,55 @@ components:
       enum:
       - xml
       - html
+    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'
     NonSplittingTagCommaSeparatedList:
       allOf:
       - $ref: '#/components/schemas/TagCommaSeparatedList'
