@inklok/api-spec 7.9.2 → 7.9.3

package/openapi.yaml

@@ -8,7 +8,7 @@ info:
     Authenticate using an API key or bearer token, then use the resources below to manage
     templates, agreements, documents, and signing. For your first integration, start with
     the Quick Start guide.
-  version: "7.9.2"
+  version: "7.9.3"
   contact:
     name: Inklok API Support
     email: support@inklok.com
@@ -752,7 +752,8 @@ paths:
       summary: Get Platform API usage health
       x-visibility: internal
       description: |
-        Returns a small operational API usage health view for platform administrators.
+        Returns a small operational published-API usage health view for platform administrators.
+        Cognito-authenticated first-party application traffic is excluded.
         This endpoint uses existing usage counters and does not expose customer-facing analytics.
       x-required-global-roles: [PLATFORM_ADMIN]
       tags:
@@ -778,6 +779,16 @@ paths:
               - usagePercentage
             default: throttleCount
           description: Sort order for returned organizations.
+        - in: query
+          name: filter
+          schema:
+            type: string
+            enum:
+              - all
+              - throttled
+              - approaching
+            default: all
+          description: Optional status subset. Approaching means non-throttled organizations at 60% usage or higher.
         - in: query
           name: limit
           schema:
@@ -5069,10 +5080,13 @@ components:
       required:
         - window
         - sort
+        - filter
         - limit
         - nextCursor
         - organizations
         - totalOrganizations
+        - totalThrottledOrganizations
+        - totalApproachingLimitOrganizations
         - dataSource
         - generatedAt
       properties:
@@ -5088,6 +5102,12 @@ components:
           enum:
             - throttleCount
             - usagePercentage
+        filter:
+          type: string
+          enum:
+            - all
+            - throttled
+            - approaching
         limit:
           type: integer
           minimum: 1
@@ -5101,6 +5121,12 @@ components:
         totalOrganizations:
           type: integer
           minimum: 0
+        totalThrottledOrganizations:
+          type: integer
+          minimum: 0
+        totalApproachingLimitOrganizations:
+          type: integer
+          minimum: 0
         dataSource:
           type: object
           required:
@@ -5125,9 +5151,9 @@ components:
               enum:
                 - peak_minute
                 - daily_capacity
-      generatedAt:
-        type: string
-        format: date-time
+        generatedAt:
+          type: string
+          format: date-time
 
     PlatformBillingActivityType:
       type: string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inklok/api-spec",
-  "version": "7.9.2",
+  "version": "7.9.3",
   "description": "Canonical OpenAPI specification for the Inklok public API.",
   "main": "openapi.yaml",
   "license": "MIT",