Skip to content

fix: joi supports string values with null default #361

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
mnahkies merged 1 commit into from
Aug 13, 2025
Merged

fix: joi supports string values with null default #361

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
42 changes: 42 additions & 0 deletions ...s/openapi-code-generator/src/typescript/common/schema-builders/joi-schema-builder.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,6 +625,20 @@ describe.each(testVersions)(

await expect(execute(undefined)).resolves.toBe(0)
})

it("supports default values of null when nullable", async () => {
const {code, execute} = await getActualFromModel({
...base,
nullable: true,
default: null,
})

expect(code).toMatchInlineSnapshot(
`"const x = joi.number().allow(null).default(null)"`,
)

await expect(execute(undefined)).resolves.toBeNull()
})
})

describe("strings", () => {
Expand Down Expand Up @@ -766,6 +780,20 @@ describe.each(testVersions)(
await expect(execute(undefined)).resolves.toBe("example")
})

it("supports default values of null when nullable", async () => {
const {code, execute} = await getActualFromModel({
...base,
nullable: true,
default: null,
})

expect(code).toMatchInlineSnapshot(
`"const x = joi.string().allow(null).default(null)"`,
)

await expect(execute(undefined)).resolves.toBeNull()
})

it("supports empty string default values", async () => {
const {code, execute} = await getActualFromModel({
...base,
Expand Down Expand Up @@ -906,6 +934,20 @@ describe.each(testVersions)(
await expect(execute(undefined)).resolves.toBe(true)
})

it("supports default values of null when nullable", async () => {
const {code, execute} = await getActualFromModel({
...base,
nullable: true,
default: null,
})

expect(code).toMatchInlineSnapshot(
`"const x = joi.boolean().truthy(1, "1").falsy(0, "0").allow(null).default(null)"`,
)

await expect(execute(undefined)).resolves.toBeNull()
})

it("support enum of 'true'", async () => {
const {code, execute} = await getActualFromModel({
...base,
Expand Down
5 changes: 4 additions & 1 deletion packages/openapi-code-generator/src/typescript/common/schema-builders/joi-schema-builder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,10 @@ export class JoiBuilder extends AbstractSchemaBuilder<
// for stuff like this, eg: https://github.com/github/rest-api-description/issues/3878
// lets coerce defaults to be strings when the model type is expecting that.
const needsWrapping =
model.type === "string" && typeof model.default !== "string"
model.type === "string" &&
typeof model.default !== "string" &&
!(model.nullable && model.default === null)

const defaultValue = JSON.stringify(model.default)

return [
Expand Down