Merge pull request #3431 from hey-api/copilot/fix-blob-file-types-generation

fix: generate `Blob | File` for `contentMediaType` schema property in OpenAPI 3.1

Author: mrlubos

.changeset/fluffy-geese-love.md

@@ -0,0 +1,6 @@
+---
+"@hey-api/openapi-ts": patch
+"@hey-api/shared": patch
+---
+
+**parser**: handle OpenAPI 3.1 `contentMediaType` keyword as binary format when file-like

packages/openapi-ts-tests/main/test/3.1.x.test.ts

@@ -193,6 +193,13 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'handles binary content',
     },
+    {
+      config: createConfig({
+        input: 'content-media-type.yaml',
+        output: 'content-media-type',
+      }),
+      description: 'handles contentMediaType schema property for file uploads',
+    },
     {
       config: createConfig({
         input: 'content-types.yaml',

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/content-media-type/index.ts

@@ -0,0 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type { ClientOptions, FileUploadRequest, FileUploadRequestTyped, UploadFileData, UploadFileResponses, UploadFileTypedData, UploadFileTypedResponses } from './types.gen';

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/content-media-type/types.gen.ts

@@ -0,0 +1,47 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
+
+export type FileUploadRequest = {
+    /**
+     * Binary file content
+     */
+    file: Blob | File;
+};
+
+export type FileUploadRequestTyped = {
+    /**
+     * Binary file content with explicit string type
+     */
+    file: Blob | File;
+};
+
+export type UploadFileData = {
+    body?: FileUploadRequest;
+    path?: never;
+    query?: never;
+    url: '/upload';
+};
+
+export type UploadFileResponses = {
+    /**
+     * OK
+     */
+    200: unknown;
+};
+
+export type UploadFileTypedData = {
+    body?: FileUploadRequestTyped;
+    path?: never;
+    query?: never;
+    url: '/upload-typed';
+};
+
+export type UploadFileTypedResponses = {
+    /**
+     * OK
+     */
+    200: unknown;
+};

packages/shared/src/openApi/3.1.x/parser/schema.ts

@@ -1,4 +1,5 @@
 import type { Context } from '../../../ir/context';
+import { isMediaTypeFileLike } from '../../../ir/mediaType';
 import type { IR } from '../../../ir/types';
 import { addItemsToSchema } from '../../../ir/utils';
 import type {
@@ -231,6 +232,11 @@ const parseSchemaMeta = ({
 
   if (schema.format) {
     irSchema.format = schema.format;
+  } else if (
+    schema.contentMediaType &&
+    isMediaTypeFileLike({ mediaType: schema.contentMediaType })
+  ) {
+    irSchema.format = 'binary';
   }
 
   if (schema.maximum !== undefined) {
@@ -1364,6 +1370,15 @@ export const schemaToIrSchema = ({
     });
   }
 
+  // infer string with binary format based on contentMediaType
+  if (schema.contentMediaType && isMediaTypeFileLike({ mediaType: schema.contentMediaType })) {
+    return parseType({
+      context,
+      schema: { ...schema, type: 'string' } as SchemaWithRequired<SchemaObject, 'type'>,
+      state,
+    });
+  }
+
   return parseUnknown({ context, schema });
 };
 

specs/3.1.x/content-media-type.yaml

@@ -0,0 +1,46 @@
+openapi: 3.1.0
+info:
+  title: OpenAPI 3.1.0 contentMediaType example
+  version: '1'
+paths:
+  /upload:
+    post:
+      operationId: uploadFile
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/FileUploadRequest'
+      responses:
+        '200':
+          description: OK
+  /upload-typed:
+    post:
+      operationId: uploadFileTyped
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/FileUploadRequestTyped'
+      responses:
+        '200':
+          description: OK
+components:
+  schemas:
+    FileUploadRequest:
+      type: object
+      required:
+        - file
+      properties:
+        file:
+          contentMediaType: application/octet-stream
+          description: Binary file content
+    FileUploadRequestTyped:
+      type: object
+      required:
+        - file
+      properties:
+        file:
+          type: string
+          contentMediaType: application/octet-stream
+          description: Binary file content with explicit string type