Fix parameter schema. Fixes #71 (#77)

jasonblanchard · web-flow · commit 0ee494dd6d3f · 2025-11-01T14:31:52.000-04:00
diff --git a/examples/kitchensink/api.ts b/examples/kitchensink/api.ts
@@ -95,6 +95,8 @@ const API: ServerTypes.Server<Request, Response> = {
 
   listPets: server.listPetsUnimplemented,
 
+  listPetsBySize: server.listPetsBySizeUnimplemented,
+
   getPetImage: async (): ServerTypes.GetPetImageResult => {
     const image = await fs.readFile(join(__dirname, `./cat.jpeg`), {
       encoding: "base64",
diff --git a/examples/kitchensink/app.test.ts b/examples/kitchensink/app.test.ts
@@ -137,30 +137,53 @@ describe("listPets", async () => {
     assert.equal(response.status, 501);
     assert.equal(response.body.message, "Not Implemented");
   });
+});
 
-  describe("getPetImage", async () => {
-    it("returns 200", async () => {
-      const response = await request(app)
-        .get("/api/v3/pet/123/image")
-        .set("Accept", "image/jpeg");
+describe("listPetsBySize", async () => {
+  it("propagates unimplemented error", async () => {
+    const response = await request(app)
+      .get("/api/v3/pets/small")
+      .set("Accept", "application/json");
 
-      assert.equal(response.status, 200);
-      assert(response.body);
-      assert.equal(response.headers["content-type"], "image/jpeg");
-    });
+    assert.equal(response.status, 501);
+    assert.equal(response.body.message, "Not Implemented");
   });
 
-  describe("getPetWebpage", async () => {
-    it("returns 200", async () => {
-      const response = await request(app)
-        .get("/api/v3/pet/123/webpage")
-        .set("Accept", "text/html");
-
-      assert.equal(response.status, 200);
-      assert.equal(
-        response.text,
-        "<html><body><h1>Hello, pet 123!</h1></body></html>",
-      );
-    });
+  it("fails with unknown enums", async () => {
+    const response = await request(app)
+      .get("/api/v3/pets/blarge")
+      .set("Accept", "application/json");
+
+    assert.equal(response.status, 400);
+    assert.equal(
+      response.body.message,
+      "request/params/size must be equal to one of the allowed values: small, medium, large",
+    );
+  });
+});
+
+describe("getPetImage", async () => {
+  it("returns 200", async () => {
+    const response = await request(app)
+      .get("/api/v3/pet/123/image")
+      .set("Accept", "image/jpeg");
+
+    assert.equal(response.status, 200);
+    assert(response.body);
+    assert.equal(response.headers["content-type"], "image/jpeg");
+  });
+});
+
+describe("getPetWebpage", async () => {
+  it("returns 200", async () => {
+    const response = await request(app)
+      .get("/api/v3/pet/123/webpage")
+      .set("Accept", "text/html");
+
+    assert.equal(response.status, 200);
+    assert.equal(
+      response.text,
+      "<html><body><h1>Hello, pet 123!</h1></body></html>",
+    );
   });
 });
diff --git a/examples/kitchensink/gen/schema.d.ts b/examples/kitchensink/gen/schema.d.ts
@@ -21,6 +21,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/pets/{size}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Returns all pets with a specific size */
+        get: operations["listPetsBySize"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/pet/{petId}": {
         parameters: {
             query?: never;
@@ -89,6 +106,8 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        /** @enum {string} */
+        PetSize: "small" | "medium" | "large";
         ErrorResponse: {
             message?: string;
         };
@@ -159,6 +178,40 @@ export interface operations {
             };
         };
     };
+    listPetsBySize: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Size of the pets to return */
+                size: components["schemas"]["PetSize"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description A list of pets. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        pets?: components["schemas"]["Pet"][];
+                    };
+                };
+            };
+            /** @description unexpected error */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
     getPetById: {
         parameters: {
             query?: never;
diff --git a/examples/kitchensink/gen/server.ts b/examples/kitchensink/gen/server.ts
@@ -31,6 +31,30 @@ export async function listPetsUnimplemented(): ListPetsResult {
   throw new NotImplementedError()
 }
 
+export interface ListPetsBySizeArgs<Req, Res> {
+  parameters: paths['/pets/{size}']['get']['parameters'];
+  contentType: string;
+  req: Req;
+  res: Res;
+}
+
+interface ListPetsBySizeResult200 {
+  content: { 200: paths['/pets/{size}']['get']['responses']['200']['content'] };
+  headers?: { [name: string]: any };
+}
+
+interface ListPetsBySizeResultDefault {
+  content: { default: paths['/pets/{size}']['get']['responses']['default']['content'] };
+  headers?: { [name: string]: any };
+  status: number;
+}
+
+export type ListPetsBySizeResult = Promise<ListPetsBySizeResult200 | ListPetsBySizeResultDefault>;
+
+export async function listPetsBySizeUnimplemented(): ListPetsBySizeResult {
+  throw new NotImplementedError()
+}
+
 export interface GetPetByIdArgs<Req, Res> {
   parameters: paths['/pet/{petId}']['get']['parameters'];
   contentType: string;
@@ -166,6 +190,10 @@ export interface Server<Req = unknown, Res = unknown> {
   listPets: (
     args: ListPetsArgs<Req, Res>
   ) => ListPetsResult;
+  /** Returns all pets with a specific size */
+  listPetsBySize: (
+    args: ListPetsBySizeArgs<Req, Res>
+  ) => ListPetsBySizeResult;
   getPetById: (
     args: GetPetByIdArgs<Req, Res>
   ) => GetPetByIdResult;
@@ -190,6 +218,11 @@ export function registerRouteHandlers<Req, Res>(server: Server<Req, Res>): Route
       path: "/pets",
       handler: server.listPets as Route["handler"],
     },
+    {
+      method: "get",
+      path: "/pets/{size}",
+      handler: server.listPetsBySize as Route["handler"],
+    },
     {
       method: "get",
       path: "/pet/{petId}",
diff --git a/examples/kitchensink/openapi.yaml b/examples/kitchensink/openapi.yaml
@@ -27,6 +27,35 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ErrorResponse"
+  /pets/{size}:
+    get:
+      operationId: listPetsBySize
+      summary: Returns all pets with a specific size
+      parameters:
+        - name: size
+          in: path
+          description: Size of the pets to return
+          required: true
+          schema:
+            $ref: "#/components/schemas/PetSize"
+      responses:
+        "200":
+          description: A list of pets.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  pets:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/Pet"
+        "default":
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
   /pet/{petId}:
     get:
       operationId: getPetById
@@ -188,6 +217,12 @@ paths:
                 type: string
 components:
   schemas:
+    PetSize:
+      type: string
+      enum:
+        - small
+        - medium
+        - large
     ErrorResponse:
       type: object
       properties:
diff --git a/packages/openapi-typescript-server-runtime/src/schema.ts b/packages/openapi-typescript-server-runtime/src/schema.ts
@@ -35,9 +35,7 @@ export const OpenAPISpec = z.object({
               name: z.string(),
               in: z.string(),
               required: z.boolean().optional(),
-              schema: z.object({
-                type: z.string(),
-              }),
+              schema: Schema,
             }),
           )
           .optional(),
