fix: name sparsekernel request schemas

Author: AbrahamGreenman

packages/sparsekernel-client/src/index.ts

@@ -149,6 +149,11 @@ export type SparseKernelAppendTranscriptEventInput = {
   created_at?: string | null;
 };
 
+export type SparseKernelListTranscriptEventsInput = {
+  session_id: string;
+  limit?: number;
+};
+
 export type SparseKernelToolCall = {
   id: string;
   task_id?: string | null;
@@ -300,6 +305,10 @@ export type SparseKernelAcquireBrowserContextInput = {
   allowed_origins?: unknown;
 };
 
+export type SparseKernelReleaseBrowserContextInput = {
+  context_id: string;
+};
+
 export type SparseKernelBrowserObservationInput = {
   context_id: string;
   target_id?: string | null;
@@ -425,6 +434,10 @@ export type SparseKernelAllocateSandboxInput = {
   max_bytes_out?: number | null;
 };
 
+export type SparseKernelReleaseSandboxInput = {
+  allocation_id: string;
+};
+
 export type SparseKernelCreateToolCallInput = {
   id?: string;
   task_id?: string | null;
@@ -440,6 +453,15 @@ export type SparseKernelCompleteToolCallInput = {
   artifact_ids?: string[];
 };
 
+export type SparseKernelToolCallIdInput = {
+  id: string;
+};
+
+export type SparseKernelFailToolCallInput = {
+  id: string;
+  error: string;
+};
+
 export type SparseKernelCapability = {
   id: string;
   subject_type: string;
@@ -472,6 +494,15 @@ export type SparseKernelCapabilityCheckInput = {
   audit_denied?: boolean;
 };
 
+export type SparseKernelCapabilityIdInput = {
+  id: string;
+};
+
+export type SparseKernelListCapabilitiesInput = {
+  subject_type: string;
+  subject_id: string;
+};
+
 function protocolMajor(version: string): string {
   const trimmed = version.trim();
   const match = /(?:^|[._-])v?(\d+)$/i.exec(trimmed);
@@ -578,10 +609,9 @@ export class SparseKernelClient {
     return await this.postJson<SparseKernelTranscriptEvent>("/transcript-events/append", input);
   }
 
-  async transcriptEvents(input: {
-    session_id: string;
-    limit?: number;
-  }): Promise<SparseKernelTranscriptEvent[]> {
+  async transcriptEvents(
+    input: SparseKernelListTranscriptEventsInput,
+  ): Promise<SparseKernelTranscriptEvent[]> {
     return await this.postJson<SparseKernelTranscriptEvent[]>("/transcript-events/list", input);
   }
 
@@ -643,9 +673,10 @@ export class SparseKernelClient {
   }
 
   async releaseBrowserContext(contextId: string): Promise<boolean> {
-    const response = await this.postJson<{ released: boolean }>("/browser/contexts/release", {
+    const input: SparseKernelReleaseBrowserContextInput = {
       context_id: contextId,
-    });
+    };
+    const response = await this.postJson<{ released: boolean }>("/browser/contexts/release", input);
     return response.released;
   }
 
@@ -723,9 +754,10 @@ export class SparseKernelClient {
   }
 
   async releaseSandbox(allocationId: string): Promise<boolean> {
-    const response = await this.postJson<{ released: boolean }>("/sandbox/release", {
+    const input: SparseKernelReleaseSandboxInput = {
       allocation_id: allocationId,
-    });
+    };
+    const response = await this.postJson<{ released: boolean }>("/sandbox/release", input);
     return response.released;
   }
 
@@ -738,15 +770,17 @@ export class SparseKernelClient {
   }
 
   async startToolCall(id: string): Promise<SparseKernelToolCall> {
-    return await this.postJson<SparseKernelToolCall>("/tool-calls/start", { id });
+    const input: SparseKernelToolCallIdInput = { id };
+    return await this.postJson<SparseKernelToolCall>("/tool-calls/start", input);
   }
 
   async completeToolCall(input: SparseKernelCompleteToolCallInput): Promise<SparseKernelToolCall> {
     return await this.postJson<SparseKernelToolCall>("/tool-calls/complete", input);
   }
 
   async failToolCall(id: string, error: string): Promise<SparseKernelToolCall> {
-    return await this.postJson<SparseKernelToolCall>("/tool-calls/fail", { id, error });
+    const input: SparseKernelFailToolCallInput = { id, error };
+    return await this.postJson<SparseKernelToolCall>("/tool-calls/fail", input);
   }
 
   async grantCapability(input: SparseKernelGrantCapabilityInput): Promise<SparseKernelCapability> {
@@ -759,14 +793,14 @@ export class SparseKernelClient {
   }
 
   async revokeCapability(id: string): Promise<boolean> {
-    const response = await this.postJson<{ revoked: boolean }>("/capabilities/revoke", { id });
+    const input: SparseKernelCapabilityIdInput = { id };
+    const response = await this.postJson<{ revoked: boolean }>("/capabilities/revoke", input);
     return response.revoked;
   }
 
-  async listCapabilities(subject: {
-    subject_type: string;
-    subject_id: string;
-  }): Promise<SparseKernelCapability[]> {
+  async listCapabilities(
+    subject: SparseKernelListCapabilitiesInput,
+  ): Promise<SparseKernelCapability[]> {
     return await this.postJson<SparseKernelCapability[]>("/capabilities/list", subject);
   }
 

schemas/sparsekernel.openapi.yaml

@@ -224,11 +224,7 @@ paths:
         content:
           application/json:
             schema:
-              type: object
-              required: [session_id]
-              properties:
-                session_id: { type: string }
-                limit: { type: integer }
+              $ref: "#/components/schemas/ListTranscriptEventsInput"
       responses:
         "200":
           description: Session transcript events
@@ -483,10 +479,7 @@ paths:
         content:
           application/json:
             schema:
-              type: object
-              required: [context_id]
-              properties:
-                context_id: { type: string }
+              $ref: "#/components/schemas/ReleaseBrowserContextInput"
       responses:
         "200":
           description: Release result
@@ -614,10 +607,7 @@ paths:
         content:
           application/json:
             schema:
-              type: object
-              required: [allocation_id]
-              properties:
-                allocation_id: { type: string }
+              $ref: "#/components/schemas/ReleaseSandboxInput"
       responses:
         "200":
           description: Release result
@@ -649,9 +639,7 @@ paths:
         content:
           application/json:
             schema:
-              type: object
-              properties:
-                now: { type: string }
+              $ref: "#/components/schemas/ReleaseExpiredLeasesInput"
       responses:
         "200":
           description: Expired lease release counts
@@ -702,10 +690,7 @@ paths:
         content:
           application/json:
             schema:
-              type: object
-              required: [id]
-              properties:
-                id: { type: string }
+              $ref: "#/components/schemas/CapabilityIdInput"
       responses:
         "200":
           description: Revoke result
@@ -724,11 +709,7 @@ paths:
         content:
           application/json:
             schema:
-              type: object
-              required: [subject_type, subject_id]
-              properties:
-                subject_type: { type: string }
-                subject_id: { type: string }
+              $ref: "#/components/schemas/ListCapabilitiesInput"
       responses:
         "200":
           description: Subject capabilities
@@ -1049,6 +1030,12 @@ components:
         tool_call_id: { type: [string, "null"] }
         token_count: { type: [integer, "null"] }
         created_at: { type: [string, "null"] }
+    ListTranscriptEventsInput:
+      type: object
+      required: [session_id]
+      properties:
+        session_id: { type: string }
+        limit: { type: integer }
     ToolCall:
       type: object
       required: [id, tool_name, status, created_at]
@@ -1200,6 +1187,11 @@ components:
         max_contexts: { type: integer }
         cdp_endpoint: { type: [string, "null"] }
         allowed_origins: true
+    ReleaseBrowserContextInput:
+      type: object
+      required: [context_id]
+      properties:
+        context_id: { type: string }
     BrowserObservationInput:
       type: object
       required: [context_id, observation_type]
@@ -1253,6 +1245,10 @@ components:
       properties:
         tasks: { type: integer }
         resources: { type: integer }
+    ReleaseExpiredLeasesInput:
+      type: object
+      properties:
+        now: { type: string }
     SandboxAllocation:
       type: object
       required: [id, trust_zone_id, backend, status, created_at]
@@ -1290,6 +1286,11 @@ components:
         docker_image: { type: [string, "null"] }
         max_runtime_ms: { type: [integer, "null"] }
         max_bytes_out: { type: [integer, "null"] }
+    ReleaseSandboxInput:
+      type: object
+      required: [allocation_id]
+      properties:
+        allocation_id: { type: string }
     Capability:
       type: object
       required: [id, subject_type, subject_id, resource_type, action, created_at]
@@ -1325,6 +1326,17 @@ components:
         action: { type: string }
         context: true
         audit_denied: { type: boolean }
+    CapabilityIdInput:
+      type: object
+      required: [id]
+      properties:
+        id: { type: string }
+    ListCapabilitiesInput:
+      type: object
+      required: [subject_type, subject_id]
+      properties:
+        subject_type: { type: string }
+        subject_id: { type: string }
     Artifact:
       type: object
       required: [id, sha256, size_bytes, storage_ref, created_at]

scripts/check-sparsekernel-openapi.mjs

@@ -19,6 +19,7 @@ const CLIENT_SCHEMA_MAPPINGS = [
   mapping("SparseKernelTranscriptEvent", "TranscriptEvent"),
   mapping("SparseKernelUpsertSessionInput", "UpsertSessionInput"),
   mapping("SparseKernelAppendTranscriptEventInput", "AppendTranscriptEventInput"),
+  mapping("SparseKernelListTranscriptEventsInput", "ListTranscriptEventsInput"),
   mapping("SparseKernelToolCall", "ToolCall"),
   mapping("SparseKernelAuditEvent", "AuditEvent"),
   mapping("SparseKernelArtifact", "Artifact"),
@@ -38,6 +39,7 @@ const CLIENT_SCHEMA_MAPPINGS = [
   mapping("SparseKernelBrowserTarget", "BrowserTarget"),
   mapping("SparseKernelBrowserObservation", "BrowserObservation"),
   mapping("SparseKernelAcquireBrowserContextInput", "AcquireBrowserContextInput"),
+  mapping("SparseKernelReleaseBrowserContextInput", "ReleaseBrowserContextInput"),
   mapping("SparseKernelBrowserObservationInput", "BrowserObservationInput"),
   mapping("SparseKernelRecordBrowserTargetInput", "RecordBrowserTargetInput"),
   mapping("SparseKernelCloseBrowserTargetInput", "CloseBrowserTargetInput"),
@@ -49,15 +51,21 @@ const CLIENT_SCHEMA_MAPPINGS = [
   mapping("SparseKernelHeartbeatTaskInput", "HeartbeatTaskInput"),
   mapping("SparseKernelCompleteTaskInput", "CompleteTaskInput"),
   mapping("SparseKernelFailTaskInput", "FailTaskInput"),
+  mapping("SparseKernelReleaseExpiredLeasesInput", "ReleaseExpiredLeasesInput"),
   mapping("SparseKernelReleaseExpiredLeasesResult", "ReleaseExpiredLeasesResult"),
   mapping("SparseKernelSandboxAllocation", "SandboxAllocation"),
   mapping("SparseKernelSandboxBackendProbe", "SandboxBackendProbe"),
   mapping("SparseKernelAllocateSandboxInput", "AllocateSandboxInput"),
+  mapping("SparseKernelReleaseSandboxInput", "ReleaseSandboxInput"),
   mapping("SparseKernelCreateToolCallInput", "CreateToolCallInput"),
+  mapping("SparseKernelToolCallIdInput", "ToolCallIdInput"),
   mapping("SparseKernelCompleteToolCallInput", "CompleteToolCallInput"),
+  mapping("SparseKernelFailToolCallInput", "FailToolCallInput"),
   mapping("SparseKernelCapability", "Capability"),
   mapping("SparseKernelGrantCapabilityInput", "GrantCapabilityInput"),
   mapping("SparseKernelCapabilityCheckInput", "CapabilityCheckInput"),
+  mapping("SparseKernelCapabilityIdInput", "CapabilityIdInput"),
+  mapping("SparseKernelListCapabilitiesInput", "ListCapabilitiesInput"),
 ];
 
 function mapping(clientType, schemaName, options = {}) {