v3.1.1

What's Changed

Other Changes

• Fix createParamOrRef by @samchungy in #336

  This fixes a breaking change unintentionally introduced in the previous release.

Full Changelog: v3.1.0...v3.1.1

v3.1.0

What's Changed

New Features 🎉

• CreateDocumentOptions

  This adds a couple global options to allow you to change how your OpenAPI documentation is rendered. Previously you needed to apply these on a field level to every type. Check the README for more details.

  • Add default date schema option by @mdoi2 in #330
  • Add unionOneOf global override by @samchungy in #331

• Introduce createSchema by @samchungy in #325

  This enables users to be able to create individual schemas without needing to scaffold the whole createDocument function.

New Contributors

• @mdoi2 made their first contribution in #330

Full Changelog: v3.0.1...v3.1.0

v3.0.1

What's Changed

Breaking Changes 🛠

• Move api to zod-openapi/api by @samchungy in #316

  This moves some internal functions previously exported via the api namespace to a zod-openapi/api subpath import.

• Require Node 18 by @samchungy in #317

New Contributors

• @tmcw made their first contribution in #291

Full Changelog: v2.19.0...v3.0.1

v3.0.0-beta.0

What's Changed

Breaking Changes 🛠

• Move api import to subpath by @samchungy in #316
• Require Node 18 by @samchungy in #317

Other Changes

• Update README.md by @tmcw in #291

New Contributors

• @tmcw made their first contribution in #291

Full Changelog: v2.19.0...v3.0.0

v2.19.0

What's Changed

New Features 🎉

• This release addresses ESM/CJS and subpath type issues for this library but as a side-effect also contains some minor BREAKING CHANGES to the types. If you were previously importing types directly from a subpath, you will now need to import them directly from the lib. There should be effect on the runtime functionality of the library.

  - import { ServerObject } from 'zod-openapi/lib-types/openapi3-ts/dist/oas31';
  - declare const server: ServerObject;
  
  + import { oas31 } from 'zod-openapi 
  + declare const server: oas31.ServerObject;

  This change also omits some extraneous class and function types from the openapi3-ts types that this library re-exports.

Other Changes

• Publish with Crackle by @samchungy in #287
• Bump openapi3-ts from 4.3.2 to 4.3.3 by @dependabot in #284
• Optimise Types by @samchungy in #288

Full Changelog: v2.18.0...v2.19.0

v2.19.0-beta.1

What's Changed

Other Changes

• Adopt Crackle by @samchungy in #287
• Bump openapi3-ts from 4.3.2 to 4.3.3 by @dependabot in #284
• Optimise Types by @samchungy in #288

Full Changelog: v2.18.0...v2.19.0-beta.1

v2.19.0-beta.0

What's Changed

Other Changes

• Adopt Crackle by @samchungy in #287
• Bump openapi3-ts from 4.3.2 to 4.3.3 by @dependabot in #284

Full Changelog: v2.18.0...v2.19.0-beta.0

v2.18.0

What's Changed

New Features 🎉

• Add support for callbacks by @samchungy in #278

Other Changes

• Bump openapi3-ts from 4.3.1 to 4.3.2 by @dependabot in #275

Full Changelog: v2.17.0...v2.18.0

v2.18.0-beta.0

What's Changed

New Features 🎉

• Add support for callbacks by @samchungy in #278

Other Changes

• Bump openapi3-ts from 4.3.1 to 4.3.2 by @dependabot in #275

Full Changelog: v2.17.0...v2.18.0-beta.0

v2.17.0

What's Changed

New Features 🎉

• Add Auto-Extend Zod Import by @samchungy in #261

  Previously, you needed to extend Zod by importing a function and running it against Zod which is rather clunky:

  import { z } from 'zod';
  import { extendZodWithOpenApi } from 'zod-openapi';
  
  extendZodWithOpenApi(z);
    
  z.string().openapi({ description: 'hello world!', example: 'hello world' });

  You can now replace it by importing the new subpath import:

  import 'zod-openapi/extend';
  
  import { z } from 'zod';
  
  z.string().openapi({ description: 'hello world!', example: 'hello world' });

Full Changelog: v2.16.0...v2.17.0