Add depictObject to correct required props on requests.

RobinTail · RobinTail · commit 9366d0ff0843 · 2025-04-30T07:22:11.000+02:00
diff --git a/express-zod-api/src/documentation-helpers.ts b/express-zod-api/src/documentation-helpers.ts
@@ -1,4 +1,5 @@
 import type {
+  $ZodObject,
   $ZodPipe,
   $ZodTransform,
   $ZodTuple,
@@ -209,6 +210,18 @@ export const depictLiteral: Depicter = ({ jsonSchema }) => ({
   ...jsonSchema,
 });
 
+const depictObject: Depicter = ({ zodSchema, jsonSchema }, { isResponse }) => {
+  if (isResponse) return jsonSchema;
+  if (!isSchema<$ZodObject>(zodSchema, "object")) return jsonSchema;
+  const { required = [] } = jsonSchema as JSONSchema.ObjectSchema;
+  const result: string[] = [];
+  for (const key of required) {
+    const valueSchema = zodSchema._zod.def.shape[key];
+    if (valueSchema && !doesAccept(valueSchema, undefined)) result.push(key);
+  }
+  return { ...jsonSchema, required: result };
+};
+
 const ensureCompliance = ({
   $ref,
   type,
@@ -467,6 +480,7 @@ const depicters: Partial<Record<FirstPartyKind | ProprietaryBrand, Depicter>> =
     pipe: depictPipeline,
     literal: depictLiteral,
     enum: depictEnum,
+    object: depictObject,
     [ezDateInBrand]: depictDateIn,
     [ezDateOutBrand]: depictDateOut,
     [ezUploadBrand]: depictUpload,
diff --git a/express-zod-api/tests/__snapshots__/documentation.spec.ts.snap b/express-zod-api/tests/__snapshots__/documentation.spec.ts.snap
@@ -956,7 +956,7 @@ paths:
             type: string
         - name: optDefault
           in: query
-          required: true
+          required: false
           description: GET /v1/getSomething Parameter
           schema:
             type: string
@@ -971,7 +971,7 @@ paths:
               - "null"
         - name: nuDefault
           in: query
-          required: true
+          required: false
           description: GET /v1/getSomething Parameter
           schema:
             type:
@@ -2147,7 +2147,7 @@ paths:
       parameters:
         - name: any
           in: query
-          required: true
+          required: false
           description: GET /v1/getSomething Parameter
           schema: {}
       responses:
@@ -2224,7 +2224,7 @@ paths:
       parameters:
         - name: string
           in: query
-          required: true
+          required: false
           description: GET /v1/getSomething Parameter
           schema:
             format: string (preprocessed)
