Merge pull request #42 from DeepLcom/aj/AE-412-limits

AE-412: Add speech-to-text usage limits for setting limits to Admin API

Author: akash-joshi

CHANGELOG.md

@@ -25,6 +25,10 @@ typos, schema fixes, or adding examples.
 ### Deprecated
 * Removed the `openapi_gitbook.yaml` file due to redundancy. Please use `openapi.yaml` going forward
 
+## [3.10.0] - 2025-01-27
+### Added
+* Add `speech_to_text_milliseconds` field to developer key usage limits in `/v2/admin/developer-keys/limits` endpoint and `ApiKey` response schema
+
 ## [3.9.0] - 2025-12-11
 ### Added
 * Add `speech_to_text_milliseconds` field to usage reports and analytics components

openapi.json

@@ -2634,6 +2634,9 @@
                   },
                   "characters": {
                     "$ref": "#/components/schemas/ApiKeyUsageCharacters"
+                  },
+                  "speech_to_text_milliseconds": {
+                    "$ref": "#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds"
                   }
                 }
               }
@@ -5095,6 +5098,11 @@
         "type": "number",
         "example": 5000
       },
+      "ApiKeyUsageSpeechToTextMilliseconds": {
+        "description": "Restricts the number of milliseconds of speech-to-text that can be consumed by an API key in a one-month usage period.\nSetting the limit to `0` means the API key will not be able to consume speech-to-text milliseconds.\nSetting the limit to `null` disables the limit, effectively allowing unlimited usage.\n",
+        "type": "number",
+        "example": 3600000
+      },
       "ApiKey": {
         "description": "The API key.",
         "type": "object",
@@ -5126,6 +5134,9 @@
             "properties": {
               "characters": {
                 "$ref": "#/components/schemas/ApiKeyUsageCharacters"
+              },
+              "speech_to_text_milliseconds": {
+                "$ref": "#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds"
               }
             }
           }

openapi.yaml

@@ -1870,6 +1870,8 @@ paths:
                   $ref: '#/components/schemas/ApiKeyId'
                 characters:
                   $ref: '#/components/schemas/ApiKeyUsageCharacters'
+                speech_to_text_milliseconds:
+                  $ref: '#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds'
       responses:
         200:
           description: The set usage limits function returns a JSON representation of the modified API key.
@@ -3733,6 +3735,13 @@ components:
         Setting the limit to `null` disables the limit, effectively allowing unlimited usage.
       type: number
       example: 5000
+    ApiKeyUsageSpeechToTextMilliseconds:
+      description: |
+        Restricts the number of milliseconds of speech-to-text that can be consumed by an API key in a one-month usage period.
+        Setting the limit to `0` means the API key will not be able to consume speech-to-text milliseconds.
+        Setting the limit to `null` disables the limit, effectively allowing unlimited usage.
+      type: number
+      example: 3600000
     ApiKey:
       description: The API key.
       type: object
@@ -3759,6 +3768,8 @@ components:
           properties:
             characters:
               $ref: '#/components/schemas/ApiKeyUsageCharacters'
+            speech_to_text_milliseconds:
+              $ref: '#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds'
     Context:
       description: |-
         The `context` parameter makes it possible to include additional context that can influence a translation but is not translated itself.