Skip to content

fix: resolve $ref schemas for query and header param coercion #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maxholman merged 1 commit into from
Apr 9, 2026
+33 −8
Merged

fix: resolve $ref schemas for query and header param coercion #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions __tests__/__snapshots__/nullables.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ exports[`nullables 1`] = `

exports[`query and header integer params coerce strings to numbers 1`] = `
"export type Dummy = string;
export type ExpireTime = number;
export type ListFilesCommandQuery = {
exp: \`\${number}\`;
limit?: \`\${number}\` | undefined;
Expand All @@ -92,6 +93,7 @@ exports[`query and header integer params coerce strings to numbers 2`] = `
"import * as v from "valibot";

export const dummySchema = v.string();
export const expireTimeSchema = v.pipe(v.number(), v.integer(), v.minValue(0));
export const listFilesCommandQuerySchema = v.strictObject({
"exp": v.pipe(v.string(), v.digits(), v.transform((n) => Number.parseInt(n, 10)), v.number(), v.integer(), v.minValue(0)),
"limit": v.exactOptional(v.pipe(v.string(), v.digits(), v.transform((n) => Number.parseInt(n, 10)), v.number(), v.integer(), v.minValue(1), v.maxValue(100)))
Expand Down
9 changes: 6 additions & 3 deletions __tests__/nullables.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,11 @@ test("query and header integer params coerce strings to numbers", async () => {
components: {
schemas: {
Dummy: { type: "string" },
ExpireTime: {
type: "integer",
format: "int64",
minimum: 0,
},
},
},
paths: {
Expand All @@ -125,9 +130,7 @@ test("query and header integer params coerce strings to numbers", async () => {
in: "query",
required: true,
schema: {
type: "integer",
format: "int64",
minimum: 0,
$ref: "#/components/schemas/ExpireTime",
},
},
{
Expand Down
30 changes: 25 additions & 5 deletions lib/process-document.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,12 +407,32 @@ export async function processOpenApiDocument(
// });
}

if (resolvedParameter.in === "query") {
queryParameters.push(resolvedParameter);
}
if (
resolvedParameter.in === "query" ||
resolvedParameter.in === "header"
) {
// Resolve $ref schemas so the valibot coercion
// pipeline can inspect the underlying type
const resolvedSchema =
resolvedParameter.schema &&
"$ref" in resolvedParameter.schema
? (refs.get(resolvedParameter.schema.$ref) ?? undefined)
: undefined;

const paramWithResolvedSchema: oas30.ParameterObject = {
...resolvedParameter,
...(resolvedSchema &&
typeof resolvedSchema === "object" &&
!Array.isArray(resolvedSchema) && {
schema: resolvedSchema,
}),
};

if (resolvedParameter.in === "header") {
headerParameters.push(resolvedParameter);
if (resolvedParameter.in === "query") {
queryParameters.push(paramWithResolvedSchema);
} else {
headerParameters.push(paramWithResolvedSchema);
}
}
}

Expand Down
Loading