Merge pull request #173 from A5rocks/openapi-3.1

More complete OpenAPI 3.1 support in `zod-openapi`.

apps/example/src/app/cats/cats.dto.ts

@@ -40,7 +40,7 @@ export const GetCatsParamsZ = extendApi(
     id: z.string(),
   }),
   {
-    example: { id: 'mouse-terminator-2000' },
+    examples: [{ id: 'mouse-terminator-2000' }],
   }
 );
 

apps/example/src/main.spec.ts

@@ -65,6 +65,7 @@ describe('Cats', () => {
       .set('Accept', 'application/json')
       .expect(200)
       .expect({
+        // todo: this should report 3.1.0 (or use openapi 3.0.0 supporting zod-openapi)
         openapi: '3.0.0',
         paths: {
           '/': {
@@ -162,42 +163,42 @@ describe('Cats', () => {
         components: {
           schemas: {
             GetCatsDto: {
-              type: 'object',
+              type: ['object'],
               properties: {
                 cats: {
-                  type: 'array',
-                  items: { type: 'string' },
+                  type: ['array'],
+                  items: { type: ['string'] },
                   description: 'List of cats',
                 },
               },
               required: ['cats'],
               title: 'Get Cat Response',
             },
             CatDto: {
-              type: 'object',
+              type: ['object'],
               properties: {
-                name: { type: 'string' },
-                age: { type: 'number' },
-                breed: { type: 'string' },
+                name: { type: ['string'] },
+                age: { type: ['number'] },
+                breed: { type: ['string'] },
               },
               required: ['name', 'age', 'breed'],
               title: 'Cat',
               description: 'A cat',
             },
             CreateCatResponseDto: {
-              type: 'object',
+              type: ['object'],
               properties: {
-                success: { type: 'boolean' },
-                message: { type: 'string' },
-                name: { type: 'string' },
+                success: { type: ['boolean'] },
+                message: { type: ['string'] },
+                name: { type: ['string'] },
               },
               required: ['success', 'message', 'name'],
             },
             UpdateCatDto: {
-              type: 'object',
+              type: ['object'],
               properties: {
-                age: { type: 'number' },
-                breed: { type: 'string' },
+                age: { type: ['number'] },
+                breed: { type: ['string'] },
               },
               required: ['age', 'breed'],
             },

packages/zod-nestjs/src/lib/create-zod-dto.ts

@@ -143,7 +143,7 @@ export const createZodDto = <T extends OpenApiZodAny>(
           convertedSchemaObject.type.includes('null') || undefined;
         convertedSchemaObject.type = convertedSchemaObject.type.find(
           (item) => item !== 'null'
-        );
+        ) || 'string';
       } else if (convertedSchemaObject.type === 'null') {
         convertedSchemaObject.type = 'string'; // There ist no explicit null value in OpenAPI 3.0
         convertedSchemaObject.nullable = true;

packages/zod-openapi/src/lib/zod-extensions.spec.ts

@@ -10,32 +10,32 @@ describe('Zod Extensions', () => {
     extendZodWithOpenApi(z, true)
 
     const schema = z.object({
-      one: z.string().openapi({example: 'oneOne'}),
+      one: z.string().openapi({examples: ['oneOne']}),
       two: z.number(),
 
-    }).openapi({example: {one: 'oneOne', two: 42}})
+    }).openapi({examples: [{one: 'oneOne', two: 42}]})
 
     const apiSchema = generateSchema(schema);
 
     expect(apiSchema).toEqual({
-      "example": {
+      "examples": [{
         "one": "oneOne",
         "two": 42
-      },
+      }],
       "properties": {
         "one": {
-          "example": "oneOne",
-          "type": "string"
+          "examples": ["oneOne"],
+          "type": ["string"]
         },
         "two": {
-          "type": "number"
+          "type": ["number"]
         }
       },
       "required": [
         "one",
         "two"
       ],
-      "type": "object"
+      "type": ["object"]
     })
   })