feat: Support multipart requests

.changeset/hip-times-draw.md

@@ -0,0 +1,6 @@
+---
+'@sap-cloud-sdk/openapi': minor
+'@sap-cloud-sdk/openapi-generator': minor
+---
+
+[New Functionality] Support request bodies with content type "multipart/form-data".

packages/openapi-generator/package.json

@@ -44,12 +44,14 @@
     "@sap-cloud-sdk/generator-common": "^4.4.0",
     "@sap-cloud-sdk/openapi": "^4.4.0",
     "@sap-cloud-sdk/util": "^4.4.0",
+    "content-type": "^1.0.5",
     "js-yaml": "^4.1.1",
     "openapi-types": "^12.1.3",
     "swagger2openapi": "^7.0.4"
   },
   "devDependencies": {
     "@apidevtools/json-schema-ref-parser": "^14.1.1",
+    "@types/content-type": "^1.1.9",
     "@types/js-yaml": "^4.0.9",
     "mock-fs": "^5.5.0",
     "prettier": "^3.8.1",

packages/openapi-generator/src/file-serializer/__snapshots__/api-file.spec.ts.snap

@@ -21,8 +21,8 @@ export const TestApi = {
     "/test/{id}",
     {
           pathParameters: { id },
-          queryParameters,
-          headerParameters
+          headerParameters,
+          queryParameters
         },
     TestApi._defaultBasePath
   ),
@@ -91,8 +91,8 @@ export const TestApi = {
     "/test/{id}",
     {
           pathParameters: { id },
-          queryParameters,
-          headerParameters
+          headerParameters,
+          queryParameters
         },
     TestApi._defaultBasePath
   ),
@@ -133,8 +133,8 @@ export const TestApi = {
     "/test/{id}",
     {
           pathParameters: { id },
-          queryParameters,
-          headerParameters
+          headerParameters,
+          queryParameters
         },
     TestApi._defaultBasePath
   ),

packages/openapi-generator/src/file-serializer/operation.spec.ts

@@ -53,25 +53,25 @@ describe('serializeOperation', () => {
       pathPattern: '/test/{id}/{subId}'
     };
     expect(serializeOperation(operation, apiName)).toMatchInlineSnapshot(`
-      "/**
-       * Create a request builder for execution of get requests to the '/test/{id}/{subId}' endpoint.
-       * @param id - Path parameter.
-       * @param subId - Path parameter.
-       * @param queryParameters - Object containing the following keys: limit.
-       * @param headerParameters - Object containing the following keys: resource-group.
-       * @returns The request builder, use the \`execute()\` method to trigger the request.
-       */
-      getFn: (id: string, subId: string, queryParameters?: {'limit'?: number}, headerParameters?: {'resource-group'?: string}) => new OpenApiRequestBuilder<string>(
-        'get',
-        "/test/{id}/{subId}",
-        {
-              pathParameters: { id, subId },
-              queryParameters,
-              headerParameters
-            },
-        TestApi._defaultBasePath
-      )"
-    `);
+"/**
+ * Create a request builder for execution of get requests to the '/test/{id}/{subId}' endpoint.
+ * @param id - Path parameter.
+ * @param subId - Path parameter.
+ * @param queryParameters - Object containing the following keys: limit.
+ * @param headerParameters - Object containing the following keys: resource-group.
+ * @returns The request builder, use the \`execute()\` method to trigger the request.
+ */
+getFn: (id: string, subId: string, queryParameters?: {'limit'?: number}, headerParameters?: {'resource-group'?: string}) => new OpenApiRequestBuilder<string>(
+  'get',
+  "/test/{id}/{subId}",
+  {
+        pathParameters: { id, subId },
+        headerParameters,
+        queryParameters
+      },
+  TestApi._defaultBasePath
+)"
+`);
   });
 
   it('serializes operation with path and header parameters', () => {
@@ -236,22 +236,22 @@ describe('serializeOperation', () => {
     };
 
     expect(serializeOperation(operation, apiName)).toMatchInlineSnapshot(`
-      "/**
-       * Create a request builder for execution of get requests to the '/test' endpoint.
-       * @param queryParameters - Object containing the following keys: limit, page.
-       * @param headerParameters - Object containing the following keys: resource-group.
-       * @returns The request builder, use the \`execute()\` method to trigger the request.
-       */
-      getFn: (queryParameters: {'limit'?: number, 'page'?: number}, headerParameters: {'resource-group': string}) => new OpenApiRequestBuilder<any>(
-        'get',
-        "/test",
-        {
-              queryParameters,
-              headerParameters
-            },
-        TestApi._defaultBasePath
-      )"
-    `);
+"/**
+ * Create a request builder for execution of get requests to the '/test' endpoint.
+ * @param queryParameters - Object containing the following keys: limit, page.
+ * @param headerParameters - Object containing the following keys: resource-group.
+ * @returns The request builder, use the \`execute()\` method to trigger the request.
+ */
+getFn: (queryParameters: {'limit'?: number, 'page'?: number}, headerParameters: {'resource-group': string}) => new OpenApiRequestBuilder<any>(
+  'get',
+  "/test",
+  {
+        headerParameters,
+        queryParameters
+      },
+  TestApi._defaultBasePath
+)"
+`);
   });
 
   it('serializes operation with optional query and optional + required header parameters', () => {
@@ -302,22 +302,22 @@ describe('serializeOperation', () => {
     };
 
     expect(serializeOperation(operation, apiName)).toMatchInlineSnapshot(`
-      "/**
-       * Create a request builder for execution of get requests to the '/test' endpoint.
-       * @param queryParameters - Object containing the following keys: limit, page.
-       * @param headerParameters - Object containing the following keys: authentication, resource-group.
-       * @returns The request builder, use the \`execute()\` method to trigger the request.
-       */
-      getFn: (queryParameters: {'limit'?: number, 'page'?: number}, headerParameters: {'authentication': string, 'resource-group'?: string}) => new OpenApiRequestBuilder<any>(
-        'get',
-        "/test",
-        {
-              queryParameters,
-              headerParameters
-            },
-        TestApi._defaultBasePath
-      )"
-    `);
+"/**
+ * Create a request builder for execution of get requests to the '/test' endpoint.
+ * @param queryParameters - Object containing the following keys: limit, page.
+ * @param headerParameters - Object containing the following keys: authentication, resource-group.
+ * @returns The request builder, use the \`execute()\` method to trigger the request.
+ */
+getFn: (queryParameters: {'limit'?: number, 'page'?: number}, headerParameters: {'authentication': string, 'resource-group'?: string}) => new OpenApiRequestBuilder<any>(
+  'get',
+  "/test",
+  {
+        headerParameters,
+        queryParameters
+      },
+  TestApi._defaultBasePath
+)"
+`);
   });
 
   it('serializes operation with required query and optional header parameters', () => {
@@ -352,22 +352,22 @@ describe('serializeOperation', () => {
     };
 
     expect(serializeOperation(operation, apiName)).toMatchInlineSnapshot(`
-      "/**
-       * Create a request builder for execution of get requests to the '/test' endpoint.
-       * @param queryParameters - Object containing the following keys: limit.
-       * @param headerParameters - Object containing the following keys: resource-group.
-       * @returns The request builder, use the \`execute()\` method to trigger the request.
-       */
-      getFn: (queryParameters: {'limit': number}, headerParameters?: {'resource-group'?: string}) => new OpenApiRequestBuilder<any>(
-        'get',
-        "/test",
-        {
-              queryParameters,
-              headerParameters
-            },
-        TestApi._defaultBasePath
-      )"
-    `);
+"/**
+ * Create a request builder for execution of get requests to the '/test' endpoint.
+ * @param queryParameters - Object containing the following keys: limit.
+ * @param headerParameters - Object containing the following keys: resource-group.
+ * @returns The request builder, use the \`execute()\` method to trigger the request.
+ */
+getFn: (queryParameters: {'limit': number}, headerParameters?: {'resource-group'?: string}) => new OpenApiRequestBuilder<any>(
+  'get',
+  "/test",
+  {
+        headerParameters,
+        queryParameters
+      },
+  TestApi._defaultBasePath
+)"
+`);
   });
 
   it('serializes operation with required query and required header parameters', () => {
@@ -410,22 +410,22 @@ describe('serializeOperation', () => {
     };
 
     expect(serializeOperation(operation, apiName)).toMatchInlineSnapshot(`
-      "/**
-       * Create a request builder for execution of get requests to the '/test' endpoint.
-       * @param queryParameters - Object containing the following keys: limit, page.
-       * @param headerParameters - Object containing the following keys: resource-group.
-       * @returns The request builder, use the \`execute()\` method to trigger the request.
-       */
-      getFn: (queryParameters: {'limit': number, 'page'?: number}, headerParameters: {'resource-group': string}) => new OpenApiRequestBuilder<any>(
-        'get',
-        "/test",
-        {
-              queryParameters,
-              headerParameters
-            },
-        TestApi._defaultBasePath
-      )"
-    `);
+"/**
+ * Create a request builder for execution of get requests to the '/test' endpoint.
+ * @param queryParameters - Object containing the following keys: limit, page.
+ * @param headerParameters - Object containing the following keys: resource-group.
+ * @returns The request builder, use the \`execute()\` method to trigger the request.
+ */
+getFn: (queryParameters: {'limit': number, 'page'?: number}, headerParameters: {'resource-group': string}) => new OpenApiRequestBuilder<any>(
+  'get',
+  "/test",
+  {
+        headerParameters,
+        queryParameters
+      },
+  TestApi._defaultBasePath
+)"
+`);
   });
 
   it('serializes operation with only query parameters', () => {

packages/openapi-generator/src/file-serializer/operation.ts

@@ -108,6 +108,18 @@ function serializeParamsForSignature(
   }
 }
 
+function getHeaderParameters(operation: OpenApiOperation): string | undefined {
+  if (operation.requestBody?.mediaType) {
+    const contentTypeStr = `'content-type': '${operation.requestBody.mediaType}'`;
+    return operation.headerParameters.length
+      ? `headerParameters: {${contentTypeStr}, ...headerParameters}`
+      : `headerParameters: {${contentTypeStr}}`;
+  }
+  if (operation.headerParameters.length) {
+    return 'headerParameters';
+  }
+}
+
 function serializeParamsForRequestBuilder(
   operation: OpenApiOperation
 ): string | undefined {
@@ -121,13 +133,24 @@ function serializeParamsForRequestBuilder(
   }
   if (operation.requestBody) {
     params.push('body');
+    if (
+      operation.requestBody.encoding &&
+      Object.keys(operation.requestBody.encoding).length
+    ) {
+      params.push(
+        `_encoding: ${JSON.stringify(operation.requestBody.encoding)}`
+      );
+    }
+  }
+
+  const headerParam = getHeaderParameters(operation);
+  if (headerParam) {
+    params.push(headerParam);
   }
   if (operation.queryParameters.length) {
     params.push('queryParameters');
   }
-  if (operation.headerParameters.length) {
-    params.push('headerParameters');
-  }
+
   if (params.length) {
     return codeBlock`{
       ${params.join(',\n')}

packages/openapi-generator/src/openapi-types.ts

@@ -153,12 +153,41 @@ export interface OpenApiRequestBody {
    */
   schema: OpenApiSchema;
 
+  /**
+   * Media type of the body.
+   */
+  mediaType: string;
+
   /**
    * Description of the body.
    */
   description?: string;
+
+  /**
+   * Encoding options for multipart/form-data properties.
+   * Maps property names to their encoding configuration (e.g., contentType).
+   */
+  encoding?: Record<
+    string,
+    {
+      contentType: string;
+      isImplicit: boolean;
+      parsedContentTypes: {
+        type: string;
+        parameters: { [key: string]: string };
+      }[];
+    }
+  >;
 }
 
+/**
+ * Representation of a media type.
+ * @internal
+ */
+export type OpenApiMediaTypeObject = OpenAPIV3.MediaTypeObject & {
+  mediaType: string;
+};
+
 /**
  * Represents all possible Types of schemas.
  * @internal

packages/openapi-generator/src/parser/document.spec.ts

@@ -6,6 +6,10 @@ import type { OpenAPIV3 } from 'openapi-types';
 
 const options = { strictNaming: true, schemaPrefix: '', resolveExternal: true };
 describe('parseOpenApiDocument()', () => {
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
   it('does not modify input service specification', () => {
     const input: OpenAPIV3.Document = {
       ...emptyDocument,