fix: name sparsekernel response schemas

Author: AbrahamGreenman

packages/sparsekernel-client/src/index.ts

@@ -24,6 +24,18 @@ export type SparseKernelBooleanResult = {
   ok: boolean;
 };
 
+export type SparseKernelReleaseResult = {
+  released: boolean;
+};
+
+export type SparseKernelCapabilityCheckResult = {
+  allowed: boolean;
+};
+
+export type SparseKernelCapabilityRevokeResult = {
+  revoked: boolean;
+};
+
 export type SparseKernelResourceBudgets = {
   logical_agents_max: number;
   active_agent_steps_max: number;
@@ -690,7 +702,10 @@ export class SparseKernelClient {
     const input: SparseKernelReleaseBrowserContextInput = {
       context_id: contextId,
     };
-    const response = await this.postJson<{ released: boolean }>("/browser/contexts/release", input);
+    const response = await this.postJson<SparseKernelReleaseResult>(
+      "/browser/contexts/release",
+      input,
+    );
     return response.released;
   }
 
@@ -771,7 +786,7 @@ export class SparseKernelClient {
     const input: SparseKernelReleaseSandboxInput = {
       allocation_id: allocationId,
     };
-    const response = await this.postJson<{ released: boolean }>("/sandbox/release", input);
+    const response = await this.postJson<SparseKernelReleaseResult>("/sandbox/release", input);
     return response.released;
   }
 
@@ -802,13 +817,19 @@ export class SparseKernelClient {
   }
 
   async checkCapability(input: SparseKernelCapabilityCheckInput): Promise<boolean> {
-    const response = await this.postJson<{ allowed: boolean }>("/capabilities/check", input);
+    const response = await this.postJson<SparseKernelCapabilityCheckResult>(
+      "/capabilities/check",
+      input,
+    );
     return response.allowed;
   }
 
   async revokeCapability(id: string): Promise<boolean> {
     const input: SparseKernelCapabilityIdInput = { id };
-    const response = await this.postJson<{ revoked: boolean }>("/capabilities/revoke", input);
+    const response = await this.postJson<SparseKernelCapabilityRevokeResult>(
+      "/capabilities/revoke",
+      input,
+    );
     return response.revoked;
   }
 

schemas/sparsekernel.openapi.yaml

@@ -15,21 +15,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                required: [ok, service, version]
-                properties:
-                  ok: { type: boolean }
-                  service: { type: string }
-                  version: { type: string }
-                  protocol_version:
-                    type: string
-                    description: SparseKernel local API protocol version. Clients should require a compatible major.
-                  schema_version:
-                    type: integer
-                    description: Current SQLite ledger schema version.
-                  features:
-                    type: array
-                    items: { type: string }
+                $ref: "#/components/schemas/Health"
   /status:
     get:
       operationId: status
@@ -39,14 +25,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                required: [path, schema_version, counts]
-                properties:
-                  path: { type: string }
-                  schema_version: { type: integer }
-                  counts:
-                    type: object
-                    additionalProperties: { type: integer }
+                $ref: "#/components/schemas/Inspect"
   /runtime/budgets:
     get:
       operationId: getRuntimeBudgets
@@ -486,10 +465,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                required: [released]
-                properties:
-                  released: { type: boolean }
+                $ref: "#/components/schemas/ReleaseResult"
   /browser/contexts/observe:
     post:
       operationId: recordBrowserObservation
@@ -506,10 +482,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                required: [ok]
-                properties:
-                  ok: { type: boolean }
+                $ref: "#/components/schemas/BooleanResult"
   /browser/targets/record:
     post:
       operationId: recordBrowserTarget
@@ -614,10 +587,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                required: [released]
-                properties:
-                  released: { type: boolean }
+                $ref: "#/components/schemas/ReleaseResult"
   /sandbox/backends/probe:
     get:
       operationId: probeSandboxBackends
@@ -678,10 +648,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                required: [allowed]
-                properties:
-                  allowed: { type: boolean }
+                $ref: "#/components/schemas/CapabilityCheckResult"
   /capabilities/revoke:
     post:
       operationId: revokeCapability
@@ -697,10 +664,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                required: [revoked]
-                properties:
-                  revoked: { type: boolean }
+                $ref: "#/components/schemas/CapabilityRevokeResult"
   /capabilities/list:
     post:
       operationId: listCapabilities
@@ -818,6 +782,46 @@ paths:
                   $ref: "#/components/schemas/AuditEvent"
 components:
   schemas:
+    Health:
+      type: object
+      required: [ok, service, version]
+      properties:
+        ok: { type: boolean }
+        service: { type: string }
+        version: { type: string }
+        protocol_version:
+          type: string
+          description: SparseKernel local API protocol version. Clients should require a compatible major.
+        schema_version:
+          type: integer
+          description: Current SQLite ledger schema version.
+        features:
+          type: array
+          items: { type: string }
+    Inspect:
+      type: object
+      required: [path, schema_version, counts]
+      properties:
+        path: { type: string }
+        schema_version: { type: integer }
+        counts:
+          type: object
+          additionalProperties: { type: integer }
+    ReleaseResult:
+      type: object
+      required: [released]
+      properties:
+        released: { type: boolean }
+    CapabilityCheckResult:
+      type: object
+      required: [allowed]
+      properties:
+        allowed: { type: boolean }
+    CapabilityRevokeResult:
+      type: object
+      required: [revoked]
+      properties:
+        revoked: { type: boolean }
     RuntimeResourceBudgets:
       type: object
       required:

scripts/check-sparsekernel-openapi.mjs

@@ -6,7 +6,12 @@ const OPENAPI_PATH = "schemas/sparsekernel.openapi.yaml";
 const DAEMON_PATH = "crates/sparsekernel-cli/src/lib.rs";
 const CLIENT_PATH = "packages/sparsekernel-client/src/index.ts";
 const CLIENT_SCHEMA_MAPPINGS = [
+  mapping("SparseKernelHealth", "Health"),
+  mapping("SparseKernelInspect", "Inspect"),
   mapping("SparseKernelBooleanResult", "BooleanResult"),
+  mapping("SparseKernelReleaseResult", "ReleaseResult"),
+  mapping("SparseKernelCapabilityCheckResult", "CapabilityCheckResult"),
+  mapping("SparseKernelCapabilityRevokeResult", "CapabilityRevokeResult"),
   mapping("SparseKernelResourceBudgets", "RuntimeResourceBudgets"),
   mapping("SparseKernelResourceBudgetUpdateInput", "RuntimeResourceBudgetUpdateInput"),
   mapping("SparseKernelNetworkPolicy", "NetworkPolicy"),