zod-openapi 2.11.0 → 2.13.0

package/README.md

@@ -29,7 +29,7 @@ yarn add zod zod-openapi
 
 ### `extendZodWithOpenApi`
 
-This mutates Zod to add an extra `.openapi()` method. Make a side-effectful import at the top of your entry point(s).
+This mutates Zod to add an extra `.openapi()` method. Call this at the top of your entry point(s).
 
 ```typescript
 import { z } from 'zod';
@@ -182,7 +182,7 @@ Query, Path, Header & Cookie parameters can be created using the `requestParams`
 ```typescript
 createDocument({
   paths: {
-    '/jobs/:a': {
+    '/jobs/{a}': {
       put: {
         requestParams: {
           path: z.object({ a: z.string() }),
@@ -201,7 +201,7 @@ If you would like to declare parameters in a more traditional way you may also d
 ```ts
 createDocument({
   paths: {
-    '/jobs/:a': {
+    '/jobs/{a}': {
       put: {
         parameters: [
           z.string().openapi({
@@ -334,7 +334,7 @@ _Input_: Request Bodies, Request Parameters, Headers
 
 _Output_: Responses, Response Headers
 
-If a registered schema with a transform or pipeline is used in both a request and response schema you will receive an error because the created schema for each will be different. To override the creation type for a specific ZodEffect, add an `.openapi()` field on it and set the `effectType` field to `input` or `output`. This will force this library to always generate the input/output type even if we are creating a response (output) or request (input) type. You typically want to use this when you know your transform has not changed the type.
+If a registered schema with a transform or pipeline is used in both a request and response schema you will receive an error because the created schema for each will be different. To override the creation type for a specific ZodEffect, add an `.openapi()` field on it and set the `effectType` field to `input`, `output` or `same`. This will force this library to always generate the input/output type even if we are creating a response (output) or request (input) type. You typically want to set this when you know the type has not changed in the transform. `same` is the recommended choice as it will throw a type error if the input and output types in the transform drift.
 
 `.preprocess()` will always return the `output` type even if we are creating an input schema. If a different input type is required you can achieve this with a `.transform()` combined with a `.pipe()` or simply declare a manual `type` in `.openapi()`.
 
@@ -521,6 +521,7 @@ For example in `z.string().nullable()` will be rendered differently
 - ZodLiteral
 - ZodNativeEnum
   - supporting `string`, `number` and combined enums.
+- ZodNever
 - ZodNull
 - ZodNullable
 - ZodNumber
@@ -543,6 +544,7 @@ For example in `z.string().nullable()` will be rendered differently
 - ZodTuple
   - `items` mapping for `.rest()`
   - `prefixItems` mapping for OpenAPI 3.1.0+
+- ZodUndefined
 - ZodUnion
   - By default it outputs an `allOf` schema. Use `unionOneOf` to change this to output `oneOf` instead.
 - ZodUnknown