Fix: avoid double raw check in Documentation, cherry-picked 8d4b9d3.

RobinTail · RobinTail · commit 3646b363f703 · 2025-04-28T18:31:49.000+02:00
diff --git a/express-zod-api/src/documentation-helpers.ts b/express-zod-api/src/documentation-helpers.ts
@@ -31,7 +31,7 @@ import {
 import { InputSource } from "./config-type";
 import { DateInSchema, ezDateInBrand } from "./date-in-schema";
 import { DateOutSchema, ezDateOutBrand } from "./date-out-schema";
-import { hasRaw } from "./deep-checks";
+import { contentTypes } from "./content-type";
 import { DocumentationError } from "./errors";
 import { FileSchema, ezFileBrand } from "./file-schema";
 import { extractObjectSchema, IOSchema } from "./io-schema";
@@ -923,7 +923,7 @@ export const depictBody = ({
     description,
     content: { [mimeType]: media },
   };
-  if (hasRequired || hasRaw(schema)) body.required = true;
+  if (hasRequired || mimeType === contentTypes.raw) body.required = true;
   return body;
 };
 
diff --git a/express-zod-api/tests/documentation-helpers.spec.ts b/express-zod-api/tests/documentation-helpers.spec.ts
@@ -49,6 +49,7 @@ import {
   onEach,
   onMissing,
   reformatParamsInPath,
+  depictBody,
 } from "../src/documentation-helpers";
 import { walkSchema } from "../src/schema-walker";
 
@@ -731,6 +732,19 @@ describe("Documentation helpers", () => {
     });
   });
 
+  describe("depictBody", () => {
+    test("should mark ez.raw() body as required", () => {
+      const body = depictBody({
+        ...requestCtx,
+        schema: ez.raw(),
+        composition: "inline",
+        mimeType: "application/octet-stream", // raw content type
+        paramNames: [],
+      });
+      expect(body.required).toBe(true);
+    });
+  });
+
   describe("depictDateIn", () => {
     test("should set type:string, pattern and format", () => {
       expect(depictDateIn(ez.dateIn(), requestCtx)).toMatchSnapshot();
