fix: [IOCOM-2842] Add support for body in patch call

__mocks__/api.yaml

@@ -177,6 +177,19 @@ paths:
           description: "Created"
         "500":
           description: "Fatal error"   
+  /patch-test-parameter-with-body-ref:
+    patch:
+      operationId: "patchTestParameterWithBodyReference"
+      parameters:
+        - name: body
+          in: body
+          schema:
+            $ref: "#/definitions/NewModel"
+      responses:
+        "201":
+          description: "Created"
+        "500":
+          description: "Fatal error"   
 
   /test-parameter-with-dash/{path-param}:
     get:

__mocks__/openapi_v3/api.yaml

@@ -198,6 +198,19 @@ paths:
           description: "Created"
         500:
           description: "Fatal error" 
+  /patch-test-parameter-with-body-ref:
+    patch:
+      operationId: "patchTestParameterWithBodyReference"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/NewModel"
+      responses:
+        201:
+          description: "Created"
+        500:
+          description: "Fatal error" 
   /test-parameter-with-dash/{path-param}:
     get:
       operationId: "testParameterWithDash"

src/commands/gen-api-models/__tests__/__snapshots__/index.test.ts.snap

@@ -933,6 +933,8 @@ import {
   testParameterWithBodyReferenceDefaultDecoder,
   PutTestParameterWithBodyReferenceT,
   putTestParameterWithBodyReferenceDefaultDecoder,
+  PatchTestParameterWithBodyReferenceT,
+  patchTestParameterWithBodyReferenceDefaultDecoder,
   TestParameterWithDashT,
   testParameterWithDashDefaultDecoder,
   TestParameterWithDashAnUnderscoreT,
@@ -975,6 +977,7 @@ export type ApiOperation = TypeofApiCall<TestAuthBearerT> &
   TypeofApiCall<TestParameterWithReferenceT> &
   TypeofApiCall<TestParameterWithBodyReferenceT> &
   TypeofApiCall<PutTestParameterWithBodyReferenceT> &
+  TypeofApiCall<PatchTestParameterWithBodyReferenceT> &
   TypeofApiCall<TestParameterWithDashT> &
   TypeofApiCall<TestParameterWithDashAnUnderscoreT> &
   TypeofApiCall<TestWithTwoParamsT> &
@@ -998,6 +1001,7 @@ export type ParamKeys = keyof (TypeofApiParams<TestAuthBearerT> &
   TypeofApiParams<TestParameterWithReferenceT> &
   TypeofApiParams<TestParameterWithBodyReferenceT> &
   TypeofApiParams<PutTestParameterWithBodyReferenceT> &
+  TypeofApiParams<PatchTestParameterWithBodyReferenceT> &
   TypeofApiParams<TestParameterWithDashT> &
   TypeofApiParams<TestParameterWithDashAnUnderscoreT> &
   TypeofApiParams<TestWithTwoParamsT> &
@@ -1043,6 +1047,7 @@ export type WithDefaultsT<
   | TestParameterWithReferenceT
   | TestParameterWithBodyReferenceT
   | PutTestParameterWithBodyReferenceT
+  | PatchTestParameterWithBodyReferenceT
   | TestParameterWithDashT
   | TestParameterWithDashAnUnderscoreT
   | TestWithTwoParamsT
@@ -1092,6 +1097,10 @@ export type Client<
         PutTestParameterWithBodyReferenceT
       >;
 
+      readonly patchTestParameterWithBodyReference: TypeofApiCall<
+        PatchTestParameterWithBodyReferenceT
+      >;
+
       readonly testParameterWithDash: TypeofApiCall<TestParameterWithDashT>;
 
       readonly testParameterWithDashAnUnderscore: TypeofApiCall<
@@ -1193,6 +1202,13 @@ export type Client<
         >
       >;
 
+      readonly patchTestParameterWithBodyReference: TypeofApiCall<
+        ReplaceRequestParams<
+          PatchTestParameterWithBodyReferenceT,
+          Omit<RequestParams<PatchTestParameterWithBodyReferenceT>, K>
+        >
+      >;
+
       readonly testParameterWithDash: TypeofApiCall<
         ReplaceRequestParams<
           TestParameterWithDashT,
@@ -1554,6 +1570,35 @@ export function createClient<K extends ParamKeys>({
     options
   );
 
+  const patchTestParameterWithBodyReferenceT: ReplaceRequestParams<
+    PatchTestParameterWithBodyReferenceT,
+    RequestParams<PatchTestParameterWithBodyReferenceT>
+  > = {
+    method: \\"patch\\",
+
+    headers: ({ [\\"customToken\\"]: customToken }) => ({
+      \\"custom-token\\": customToken,
+
+      \\"Content-Type\\": \\"application/json\\"
+    }),
+    response_decoder: patchTestParameterWithBodyReferenceDefaultDecoder(),
+    url: ({}) => \`\${basePath}/patch-test-parameter-with-body-ref\`,
+
+    body: ({ [\\"body\\"]: body }) =>
+      body?.constructor?.name === \\"Readable\\" ||
+      body?.constructor?.name === \\"ReadableStream\\"
+        ? (body as ReadableStream)
+        : body?.constructor?.name === \\"Buffer\\"
+        ? (body as Buffer)
+        : JSON.stringify(body),
+
+    query: () => withoutUndefinedValues({})
+  };
+  const patchTestParameterWithBodyReference: TypeofApiCall<PatchTestParameterWithBodyReferenceT> = createFetchRequestForApi(
+    patchTestParameterWithBodyReferenceT,
+    options
+  );
+
   const testParameterWithDashT: ReplaceRequestParams<
     TestParameterWithDashT,
     RequestParams<TestParameterWithDashT>
@@ -1829,6 +1874,9 @@ export function createClient<K extends ParamKeys>({
     putTestParameterWithBodyReference: (withDefaults || identity)(
       putTestParameterWithBodyReference
     ),
+    patchTestParameterWithBodyReference: (withDefaults || identity)(
+      patchTestParameterWithBodyReference
+    ),
     testParameterWithDash: (withDefaults || identity)(testParameterWithDash),
     testParameterWithDashAnUnderscore: (withDefaults || identity)(
       testParameterWithDashAnUnderscore
@@ -2921,6 +2969,8 @@ import {
   testParameterWithBodyReferenceDefaultDecoder,
   PutTestParameterWithBodyReferenceT,
   putTestParameterWithBodyReferenceDefaultDecoder,
+  PatchTestParameterWithBodyReferenceT,
+  patchTestParameterWithBodyReferenceDefaultDecoder,
   TestParameterWithDashT,
   testParameterWithDashDefaultDecoder,
   TestParameterWithDashAnUnderscoreT,
@@ -2964,6 +3014,7 @@ export type ApiOperation = TypeofApiCall<TestAuthBearerT> &
   TypeofApiCall<TestParameterWithReferenceT> &
   TypeofApiCall<TestParameterWithBodyReferenceT> &
   TypeofApiCall<PutTestParameterWithBodyReferenceT> &
+  TypeofApiCall<PatchTestParameterWithBodyReferenceT> &
   TypeofApiCall<TestParameterWithDashT> &
   TypeofApiCall<TestParameterWithDashAnUnderscoreT> &
   TypeofApiCall<TestWithTwoParamsT> &
@@ -2988,6 +3039,7 @@ export type ParamKeys = keyof (TypeofApiParams<TestAuthBearerT> &
   TypeofApiParams<TestParameterWithReferenceT> &
   TypeofApiParams<TestParameterWithBodyReferenceT> &
   TypeofApiParams<PutTestParameterWithBodyReferenceT> &
+  TypeofApiParams<PatchTestParameterWithBodyReferenceT> &
   TypeofApiParams<TestParameterWithDashT> &
   TypeofApiParams<TestParameterWithDashAnUnderscoreT> &
   TypeofApiParams<TestWithTwoParamsT> &
@@ -3034,6 +3086,7 @@ export type WithDefaultsT<
   | TestParameterWithReferenceT
   | TestParameterWithBodyReferenceT
   | PutTestParameterWithBodyReferenceT
+  | PatchTestParameterWithBodyReferenceT
   | TestParameterWithDashT
   | TestParameterWithDashAnUnderscoreT
   | TestWithTwoParamsT
@@ -3085,6 +3138,10 @@ export type Client<
         PutTestParameterWithBodyReferenceT
       >;
 
+      readonly patchTestParameterWithBodyReference: TypeofApiCall<
+        PatchTestParameterWithBodyReferenceT
+      >;
+
       readonly testParameterWithDash: TypeofApiCall<TestParameterWithDashT>;
 
       readonly testParameterWithDashAnUnderscore: TypeofApiCall<
@@ -3193,6 +3250,13 @@ export type Client<
         >
       >;
 
+      readonly patchTestParameterWithBodyReference: TypeofApiCall<
+        ReplaceRequestParams<
+          PatchTestParameterWithBodyReferenceT,
+          Omit<RequestParams<PatchTestParameterWithBodyReferenceT>, K>
+        >
+      >;
+
       readonly testParameterWithDash: TypeofApiCall<
         ReplaceRequestParams<
           TestParameterWithDashT,
@@ -3584,6 +3648,35 @@ export function createClient<K extends ParamKeys>({
     options
   );
 
+  const patchTestParameterWithBodyReferenceT: ReplaceRequestParams<
+    PatchTestParameterWithBodyReferenceT,
+    RequestParams<PatchTestParameterWithBodyReferenceT>
+  > = {
+    method: \\"patch\\",
+
+    headers: ({ [\\"customToken\\"]: customToken }) => ({
+      \\"custom-token\\": customToken,
+
+      \\"Content-Type\\": \\"application/json\\"
+    }),
+    response_decoder: patchTestParameterWithBodyReferenceDefaultDecoder(),
+    url: ({}) => \`\${basePath}/patch-test-parameter-with-body-ref\`,
+
+    body: ({ [\\"body\\"]: body }) =>
+      body?.constructor?.name === \\"Readable\\" ||
+      body?.constructor?.name === \\"ReadableStream\\"
+        ? (body as ReadableStream)
+        : body?.constructor?.name === \\"Buffer\\"
+        ? (body as Buffer)
+        : JSON.stringify(body),
+
+    query: () => withoutUndefinedValues({})
+  };
+  const patchTestParameterWithBodyReference: TypeofApiCall<PatchTestParameterWithBodyReferenceT> = createFetchRequestForApi(
+    patchTestParameterWithBodyReferenceT,
+    options
+  );
+
   const testParameterWithDashT: ReplaceRequestParams<
     TestParameterWithDashT,
     RequestParams<TestParameterWithDashT>
@@ -3860,6 +3953,9 @@ export function createClient<K extends ParamKeys>({
     putTestParameterWithBodyReference: (withDefaults || identity)(
       putTestParameterWithBodyReference
     ),
+    patchTestParameterWithBodyReference: (withDefaults || identity)(
+      patchTestParameterWithBodyReference
+    ),
     testParameterWithDash: (withDefaults || identity)(testParameterWithDash),
     testParameterWithDashAnUnderscore: (withDefaults || identity)(
       testParameterWithDashAnUnderscore

src/commands/gen-api-models/__tests__/parse.test.ts

@@ -240,6 +240,32 @@ describe.each`
     );
   });
 
+  it("should parse a patch operation with body as ref", () => {
+    const parsed = getParser(spec).parseOperation(
+      //@ts-ignore
+      spec,
+      "/patch-test-parameter-with-body-ref",
+      [],
+      "undefined",
+      "undefined"
+    )("patch");
+
+    expect(parsed).toEqual(
+      expect.objectContaining({
+        method: "patch",
+        path: "/patch-test-parameter-with-body-ref",
+        consumes: "application/json",
+        parameters: expect.arrayContaining([
+          {
+            name: "body?",
+            in: "body",
+            type: "NewModel | ReadableStream<Uint8Array> | Buffer"
+          }
+        ])
+      })
+    );
+  });
+
   it("should parse an operation with header parameters", () => {
     const parsed = getParser(spec).parseOperation(
       //@ts-ignore

src/commands/gen-api-models/parse.v3.ts

@@ -349,7 +349,7 @@ export const parseOperation = (
         ]
       : [undefined, false];
   const bodyParam: ReadonlyArray<IParameterInfo> =
-    ["post", "put"].includes(method) && bodySchema
+    ["patch", "post", "put"].includes(method) && bodySchema
       ? // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
         "multipart/form-data" in operation?.requestBody?.content
@@ -398,7 +398,7 @@ export const parseOperation = (
   ];
 
   const contentTypeHeaders =
-    (method === "post" || method === "put") &&
+    (method === "patch" || method === "post" || method === "put") &&
     Object.keys([...operationParams, ...bodyParam]).length > 0
       ? ["Content-Type"]
       : [];

src/commands/gen-api-models/types.ts

@@ -20,7 +20,7 @@ export interface IGenerateApiOptions {
 /**
  * Supported http methods
  */
-export type SupportedMethod = "get" | "post" | "put" | "delete";
+export type SupportedMethod = "get" | "patch" | "post" | "put" | "delete";
 
 export type SupportedAuthScheme = "bearer" | "digest" | "none";