[IO-363] Arbitrary mediaTypes for OpenAPI 3.0

Author: Geksanit

src/language/typescript/3.0/serializers/operation-object.ts

@@ -266,6 +266,9 @@ export const getParameters = combineReader(
 	},
 );
 
+const blobMediaRegexp = /^(video|audio|image|application)/;
+const textMediaRegexp = /^text/;
+
 export const serializeOperationObject = combineReader(
 	ask<ResolveRefContext>(),
 	getParameters,
@@ -299,10 +302,13 @@ export const serializeOperationObject = combineReader(
 			fold(
 				() => 'json',
 				types => {
-					if (types.includes('application/octet-stream')) {
+					if (types.includes('application/json')) {
+						return 'json';
+					}
+					if (types.some(s => blobMediaRegexp.test(s))) {
 						return 'blob';
 					}
-					if (types.includes('text/plain')) {
+					if (types.some(s => textMediaRegexp.test(s))) {
 						return 'text';
 					}
 					return 'json';

src/language/typescript/3.0/serializers/request-body-object.ts

@@ -2,11 +2,12 @@ import { serializeSchemaObject } from './schema-object';
 import { getSerializedRefType, SerializedType } from '../../common/data/serialized-type';
 import { Either, mapLeft } from 'fp-ts/lib/Either';
 import { pipe } from 'fp-ts/lib/pipeable';
-import { either, option, record } from 'fp-ts';
+import { either, option } from 'fp-ts';
 import { fromString, Ref } from '../../../../utils/ref';
 import { RequestBodyObject } from '../../../../schema/3.0/request-body-object';
 import { ReferenceObjectCodec, ReferenceObject } from '../../../../schema/3.0/reference-object';
 import { SchemaObject } from '../../../../schema/3.0/schema-object';
+import { getKeyMatchValue } from '../../common/utils';
 
 export const serializeRequestBodyObject = (from: Ref, body: RequestBodyObject): Either<Error, SerializedType> =>
 	pipe(
@@ -25,9 +26,10 @@ export const serializeRequestBodyObject = (from: Ref, body: RequestBodyObject):
 		),
 	);
 
+const requestMediaRegexp = /^(video|audio|image|application|text|multipart\/form-data)/;
 const getSchema = (requestBodyObject: RequestBodyObject): Either<Error, ReferenceObject | SchemaObject> =>
 	pipe(
-		record.lookup('application/json', requestBodyObject.content),
+		getKeyMatchValue(requestBodyObject.content, requestMediaRegexp),
 		option.chain(media => media.schema),
 		either.fromOption(() => new Error('No schema found for ReqeustBodyObject')),
 	);

src/language/typescript/3.0/serializers/response-object.ts

@@ -7,16 +7,17 @@ import { either, option } from 'fp-ts';
 import { ResponseObject } from '../../../../schema/3.0/response-object';
 import { Option } from 'fp-ts/lib/Option';
 import { ReferenceObjectCodec } from '../../../../schema/3.0/reference-object';
+import { getKeyMatchValue } from '../../common/utils';
+
+const requestMediaRegexp = /^(video|audio|image|application|text)/;
 
 export const serializeResponseObject = (
 	from: Ref,
 	responseObject: ResponseObject,
 ): Option<Either<Error, SerializedType>> =>
 	pipe(
 		responseObject.content,
-		option.mapNullable(
-			content => content['application/json'] || content['text/plain'] || content['application/octet-stream'],
-		),
+		option.chain(content => getKeyMatchValue(content, requestMediaRegexp)),
 		option.chain(media => media.schema),
 		option.map(schema =>
 			ReferenceObjectCodec.is(schema)

src/language/typescript/common/data/serialized-type.ts

@@ -109,6 +109,7 @@ export const getSerializedStringType = (from: Ref, format: Option<string>): Eith
 							),
 						);
 					}
+					case 'base64':
 					case 'binary': {
 						return some(SERIALIZED_UNKNOWN_TYPE);
 					}

src/language/typescript/common/utils.ts

@@ -4,6 +4,9 @@ import { Options } from 'prettier';
 import { fromString, ResolveRefContext } from '../../../utils/ref';
 import { Kind } from '../../../utils/types';
 import { ask } from 'fp-ts/lib/Reader';
+import { pipe } from 'fp-ts/lib/pipeable';
+import { keys } from 'fp-ts/lib/Record';
+import { array, option } from 'fp-ts';
 
 export const SUCCESSFUL_CODES = ['200', '201', 'default'];
 export const CONTROLLERS_DIRECTORY = 'controllers';
@@ -77,3 +80,11 @@ export const getSafePropertyName = (value: string): string =>
 	value.replace(REPLACE_PATTERN, '_').replace(/^(\d)/, '_$1') || '_';
 
 export const context = ask<ResolveRefContext>();
+
+export const getKeyMatchValue = <T>(record: Record<string, T>, regexp: RegExp): option.Option<T> =>
+	pipe(
+		record,
+		keys,
+		array.findFirst(s => regexp.test(s)),
+		option.map(key => record[key]),
+	);

test/specs/3.0/file-and-text.yml

@@ -91,6 +91,55 @@ paths:
             text/plain:
               schema:
                 $ref: '#/components/schemas/Text'
+  /image:
+    get:
+      tags:
+        - media
+      summary: get image
+      operationId: loadImage
+      responses:
+        200:
+          description: succesfull operation
+          content:
+            image/png:
+              schema:
+                $ref: '#/components/schemas/File'
+                /image:
+  /audio:
+    get:
+      tags:
+        - media
+      summary: get audio
+      operationId: loadAudio
+      responses:
+        200:
+          description: succesfull operation
+          content:
+            image/png:
+              schema:
+                $ref: '#/components/schemas/File'
+  /upload:
+    post:
+      tags:
+        - media
+      summary: updload image
+      operationId: uploadImage
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                images:
+                  type: array
+                  items:
+                    type: string
+                    format: binary
+              required:
+                - images
+      responses:
+        200:
+          description: succesfull operation
 components:
   schemas:
     File: