[BUG] Getting Error while specified schema.request.headers fields.

[zzx58-027]

A minimal cloudflare API starter could reproduce the error by: bun create cloudflare@latest.

Just define the headers in request, then you could see it.

Please let me know if you need extra helps.

✘ [ERROR] TypeError: schema2.openapi is not a function
at null.
(file:///Users/zzx58/Desktop/DevProjects/Wishing-PIM/node_modules/@asteasolutions/zod-to-openapi/dist/index.mjs:1000:54)
at Array.map ()
at OpenAPIGenerator.generateInlineParameters
(file:///Users/zzx58/Desktop/DevProjects/Wishing-PIM/node_modules/@asteasolutions/zod-to-openapi/dist/index.mjs:975:58)
at enhanceMissingParametersError.location
(file:///Users/zzx58/Desktop/DevProjects/Wishing-PIM/node_modules/@asteasolutions/zod-to-openapi/dist/index.mjs:1145:24)
at enhanceMissingParametersError
(file:///Users/zzx58/Desktop/DevProjects/Wishing-PIM/node_modules/@asteasolutions/zod-to-openapi/dist/index.mjs:353:16)
at OpenAPIGenerator.getParameters
(file:///Users/zzx58/Desktop/DevProjects/Wishing-PIM/node_modules/@asteasolutions/zod-to-openapi/dist/index.mjs:1139:34)
at enhanceMissingParametersError.route
(file:///Users/zzx58/Desktop/DevProjects/Wishing-PIM/node_modules/@asteasolutions/zod-to-openapi/dist/index.mjs:1168:69)
at enhanceMissingParametersError
(file:///Users/zzx58/Desktop/DevProjects/Wishing-PIM/node_modules/@asteasolutions/zod-to-openapi/dist/index.mjs:353:16)
at OpenAPIGenerator.generatePath
(file:///Users/zzx58/Desktop/DevProjects/Wishing-PIM/node_modules/@asteasolutions/zod-to-openapi/dist/index.mjs:1168:28)
at OpenAPIGenerator.generateSingleRoute
(file:///Users/zzx58/Desktop/DevProjects/Wishing-PIM/node_modules/@asteasolutions/zod-to-openapi/dist/index.mjs:1180:31)

[nyxhawk]

You can counter this issue by defining a Zod object for the headers beforehand, as shown in the example.

import { z } from "zod";

// Define the header with Zod
const HeaderSchema = z.object({
  "X-Commit-Dev-Auto-Auth": z.string(),
});

export class GoalsList extends OpenAPIRoute {
  schema = {
    tags: ["Goals"],
    summary: "List Goals",
    request: {
      headers: HeaderSchema,
    },
    responses: {
      "200": {
        description: "Returns a list of goals",
        content: {
          "application/json": {
            schema: GoalsListResponseSchema,
          },
        },
      },
    },
  };

// handle function...

With this change, the header will appear correctly in SwaggerUI:

[zzx58-027]

@nyxhawk Hi, could you provide your chanfana version so i can test whether it's version related issue? Since i have define the header schema outside, it still don't work. Please see mine references, Thanks & Kind Regards.

[nyxhawk]

@zzx58-027 Hi, here’s the dependency set I used in my project:

"dependencies": {
  "@better-auth/expo": "^1.3.7",
  "@better-auth/stripe": "^1.3.7",
  "@commit/engine": "workspace:*",
  "@commit/types": "workspace:*",
  "better-auth": "^1.3.7",
  "better-sqlite3": "^12.2.0",
  "chanfana": "^2.6.3",
  "drizzle-orm": "^0.44.5",
  "hono": "^4.6.20",
  "stripe": "^18.5.0",
  "uuid": "^11.1.0",
  "zod": "^3.24.3"
},

As you can see, I’m using chanfana v2.6.3, so this could indeed be a version-related issue.

[zzx58-027]

@zzx58-027 Hi, here’s the dependency set I used in my project:

"dependencies": {
"@better-auth/expo": "^1.3.7",
"@better-auth/stripe": "^1.3.7",
"@commit/engine": "workspace:",
"@commit/types": "workspace:",
"better-auth": "^1.3.7",
"better-sqlite3": "^12.2.0",
"chanfana": "^2.6.3",
"drizzle-orm": "^0.44.5",
"hono": "^4.6.20",
"stripe": "^18.5.0",
"uuid": "^11.1.0",
"zod": "^3.24.3"
},
As you can see, I’m using chanfana v2.6.3, so this could indeed be a version-related issue.

Thank you for you prompt reply! I have awared of this issue. Wishing you luck!