Fix optional refs (#11)

Author: samchungy

src/rules/require-openapi/rule.test.ts

@@ -23,6 +23,7 @@ ruleTester.run(ruleName, rule, {
     test('optional-no-openapi'),
     test('reference'),
     test('object-shape-reference'),
+    test('object-property-reference-optional'),
   ],
   invalid: [
     {
@@ -37,5 +38,9 @@ ruleTester.run(ruleName, rule, {
       ...test('object-extend'),
       errors: [{ messageId: 'open-api-required' }],
     },
+    {
+      ...test('object-property-optional'),
+      errors: [{ messageId: 'open-api-required' }],
+    },
   ],
 });

src/rules/require-openapi/rule.ts

@@ -51,6 +51,15 @@ export const rule: TSESLint.RuleModule<any, any> = createRule({
           return;
         }
 
+        if (
+          type.name.startsWith('ZodOptional') &&
+          node.value.type === 'CallExpression' &&
+          node.value.callee.type === 'MemberExpression' &&
+          node.value.callee.object.type === 'Identifier'
+        ) {
+          return;
+        }
+
         const openApiCallExpression = findOpenApiCallExpression(node);
 
         if (!openApiCallExpression) {

src/rules/require-openapi/tests/object-property-optional.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+import { extendZodWithOpenApi } from 'zod-openapi';
+
+extendZodWithOpenApi(z);
+
+export const ZodObject = z
+  .object({
+    prop: z.string().optional(),
+  })
+  .openapi({ description: 'object description' });

src/rules/require-openapi/tests/object-property-reference-optional.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+import { extendZodWithOpenApi } from 'zod-openapi';
+
+extendZodWithOpenApi(z);
+
+/**
+ * string description
+ */
+const ZodString = z.string().openapi({ description: 'string description' });
+
+export const ZodObject = z
+  .object({
+    prop: ZodString.optional(),
+  })
+  .openapi({ description: 'object description' });