Sourced from @​asteasolutions/zod-to-openapi's releases.

v8.1.0

What's Changed

• Improve Zod v4 type compatibility in module augmentation (fixes #321 ) thanks to @​YeeP79
• Add option to sort schemas and parameters (fixes: #312) See more details on how to use it here

Full Changelog: asteasolutions/zod-to-openapi@v8.0.0...v8.1.0

v8.0.0

Added Zod v4 support 🚀

Support for properties from .meta

With zod's new option for generating JSON schemas and maintaining registries we've added a pretty much seamless support for all metadata information coming from .meta calls as if that was metadata passed into .openapi.

So the following 2 schemas produce exactly the same results:

const schema = z
 .string()
 .openapi('Schema', { description: 'Name of the user', example: 'Test' });
const schema2 = z
.string()
.meta({ id: 'Schema2', description: 'Name of the user', example: 'Test' });

Removing extendZodWithOpenApi

This also means that unless you are using some of our more complicated scenarios you could even generate a schema without using extendZodWithOpenApi in your codebase and only rely on .meta to provide additional metadata information and schema names (using the id property).

Where would you still need to use extendZodWithOpenApi and .openapi

1. When extending registered schemas that are both registered and want the extended one to use anyOf i.e:

const schema = z.object({ name: z.string() }).openapi('Schema');
const schema2 = schema.extend({ age: z.number() }).openapi('Schema2'); // this one would have anyOf and a reference to the first one

2. Defining parameter metadata. So for example when doing:

registry.registerPath({
 // ...
 request: {
 query: z.object({
 name: z.string().openapi({
 description: 'Schema level description',
 param: { description: 'Param level description' }, 
 }),
 }),
 },
});

... (truncated)

• be536b7 Release 8.1.0
• 63cd1ad Merge pull request #331 from asteasolutions/feature/[Feature] Mark site as default #312 -add-option-to-sort
• 9ad5797 prettier
• 83519ab add note and extends to interface definition of ZodType extension
• a80ad75 update README
• 4062104 add options to sort definitions alphabetically
• bfe73b9 ran prettier
• e0142b2 Merge pull request #322 from YeeP79/yeep79-fix-zod-v4-type-compatibility
• 48b63cc feat: fix Zod v4 type compatibility in module augmentation
• b7e70ff Release 8.0.0
• Additional commits viewable in compare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)