Minor: renaming depictRequest to depictBody. (#1794)

Addressing todo for clarity
RobinTail · May 25, 2024 · 76c2cbf · 76c2cbf
1 parent 3b7ecec
commit 76c2cbf
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/src/documentation-helpers.ts b/src/documentation-helpers.ts
@@ -1020,8 +1020,7 @@ export const depictSecurityRefs = (
   return depictSecurityRefs({ or: [container] });
 };
 
-// @todo depictBody
-export const depictRequest = ({
+export const depictBody = ({
   method,
   path,
   schema,

diff --git a/src/documentation.ts b/src/documentation.ts
@@ -20,7 +20,7 @@ import { mapLogicalContainer } from "./logical-container";
 import { Method } from "./method";
 import {
   OpenAPIContext,
-  depictRequest,
+  depictBody,
   depictRequestParams,
   depictResponse,
   depictSecurity,
@@ -221,7 +221,7 @@ export class Documentation extends OpenApiBuilder {
       }
 
       const requestBody = inputSources.includes("body")
-        ? depictRequest({
+        ? depictBody({
             ...commons,
             paramNames: pluck("name", depictedParams),
             schema: endpoint.getSchema("input"),