Merge pull request #95 from asteasolutions/feature/#94-include-suppor…

…t-for-zod-describe

#94 Added support for `zod`'s `.describe` method

spec/modifiers/describe.spec.ts

@@ -0,0 +1,43 @@
+import { z } from 'zod';
+import { expectSchema, registerSchema } from '../lib/helpers';
+
+describe('describe', () => {
+  it('generates OpenAPI schema with description when the .describe method is used', () => {
+    const schema = registerSchema(
+      'SimpleString',
+      z.string().describe('This is a test string')
+    );
+
+    expectSchema([schema], {
+      SimpleString: { type: 'string', description: 'This is a test string' },
+    });
+  });
+
+  it('can overload .openapi description when the .describe method is used', () => {
+    const schema = registerSchema(
+      'SimpleString',
+      z
+        .string()
+        .openapi({ description: 'Alternative description' })
+        .describe('This is a test string')
+    );
+
+    expectSchema([schema], {
+      SimpleString: { type: 'string', description: 'This is a test string' },
+    });
+  });
+
+  it('can overload descriptions from .describe with .openapi', () => {
+    const schema = registerSchema(
+      'SimpleString',
+      z
+        .string()
+        .describe('This is a test string')
+        .openapi({ description: 'Alternative description' })
+    );
+
+    expectSchema([schema], {
+      SimpleString: { type: 'string', description: 'Alternative description' },
+    });
+  });
+});

src/zod-extensions.ts

@@ -155,6 +155,14 @@ export function extendZodWithOpenApi(zod: typeof z) {
     return result;
   };
 
+  const zodDescribe = zod.ZodSchema.prototype.describe;
+  zod.ZodSchema.prototype.describe = function (this: any, ...args: [string]) {
+    const [description] = args;
+    const result = zodDescribe.apply(this, args).openapi({ description });
+
+    return result;
+  };
+
   const zodPick = zod.ZodObject.prototype.pick as any;
   zod.ZodObject.prototype.pick = function (this: any, ...args: any[]) {
     const result = zodPick.apply(this, args);