Merge pull request #331 from daviwil/enable-multipart-requests

Convert multipart/form-data requests to HttpMultipartRequest

modelerfour/modeler/modelerfour.ts

@@ -1,7 +1,7 @@
 import { Model as oai3, Dereferenced, dereference, Refable, JsonType, IntegerFormat, StringFormat, NumberFormat, MediaType, filterOutXDash } from '@azure-tools/openapi';
 import * as OpenAPI from '@azure-tools/openapi';
 import { items, values, Dictionary, length, keys } from '@azure-tools/linq';
-import { HttpMethod, HttpModel, CodeModel, Operation, SetType, HttpRequest, BooleanSchema, Schema, NumberSchema, ArraySchema, Parameter, ChoiceSchema, StringSchema, ObjectSchema, ByteArraySchema, CharSchema, DateSchema, DateTimeSchema, DurationSchema, UuidSchema, UriSchema, CredentialSchema, ODataQuerySchema, UnixTimeSchema, SchemaType, SchemaContext, OrSchema, XorSchema, DictionarySchema, ParameterLocation, SerializationStyle, ImplementationLocation, Property, ComplexSchema, HttpWithBodyRequest, HttpBinaryRequest, HttpParameter, Response, HttpResponse, HttpBinaryResponse, SchemaResponse, SchemaUsage, SealedChoiceSchema, ExternalDocumentation, BinaryResponse, BinarySchema, Discriminator, Relations, AnySchema, ConstantSchema, ConstantValue, HttpHeader, ChoiceValue, Language, Request, OperationGroup, TimeSchema } from '@azure-tools/codemodel';
+import { HttpMethod, HttpModel, CodeModel, Operation, SetType, HttpRequest, BooleanSchema, Schema, NumberSchema, ArraySchema, Parameter, ChoiceSchema, StringSchema, ObjectSchema, ByteArraySchema, CharSchema, DateSchema, DateTimeSchema, DurationSchema, UuidSchema, UriSchema, CredentialSchema, ODataQuerySchema, UnixTimeSchema, SchemaType, SchemaContext, OrSchema, XorSchema, DictionarySchema, ParameterLocation, SerializationStyle, ImplementationLocation, Property, ComplexSchema, HttpWithBodyRequest, HttpBinaryRequest, HttpParameter, Response, HttpResponse, HttpBinaryResponse, SchemaResponse, SchemaUsage, SealedChoiceSchema, ExternalDocumentation, BinaryResponse, BinarySchema, Discriminator, Relations, AnySchema, ConstantSchema, ConstantValue, HttpHeader, ChoiceValue, Language, Request, OperationGroup, TimeSchema, HttpMultipartRequest } from '@azure-tools/codemodel';
 import { Session, Channel } from '@azure-tools/autorest-extension-base';
 import { Interpretations, XMSEnum } from './interpretations';
 import { fail, minimum, pascalCase, knownMediaType, KnownMediaType } from '@azure-tools/codegen';
@@ -1121,10 +1121,17 @@ export class ModelerFour {
  throw new Error('NO BODY DUDE.');
 
  }
- const http = new HttpWithBodyRequest({
- knownMediaType: kmt,
- mediaTypes: kmtObject.map(each => each.mediaType),
- });
+
+ const http: HttpWithBodyRequest =
+ kmt === KnownMediaType.Multipart
+ ? new HttpMultipartRequest({
+ knownMediaType: kmt,
+ mediaTypes: ['multipart/form-data']
+ })
+ : new HttpWithBodyRequest({
+ knownMediaType: kmt,
+ mediaTypes: kmtObject.map(each => each.mediaType),
+ });
 
  // create the request object
  const httpRequest = new Request({
@@ -1152,31 +1159,72 @@ export class ModelerFour {
  }
 
  const requestSchema = values(kmtObject).first(each => !!each.schema.instance)?.schema;
- const pSchema = this.processSchema(requestSchema?.name || 'requestBody', requestSchema?.instance || <OpenAPI.Schema>{})
 
- // Track the usage of this schema as an input with media type
- this.trackSchemaUsage(pSchema, { usage: [SchemaContext.Input], serializationFormats: [kmt] });
+ if (kmt === KnownMediaType.Multipart) {
+ if (!requestSchema || !requestSchema.instance) {
+ throw new Error('Cannot process a multipart/form-data body without a schema.');
+ }
 
- httpRequest.addParameter(new Parameter(
- body.instance?.['x-ms-requestBody-name'] ?? 'body',
- this.interpret.getDescription('', body?.instance || {}),
- pSchema, {
- extensions: this.interpret.getExtensionProperties(body.instance),
- required: !!body.instance.required,
- nullable: requestSchema?.instance?.nullable,
- protocol: {
- http: new HttpParameter(ParameterLocation.Body, {
- style: <SerializationStyle><any>kmt,
- })
- },
- implementation: ImplementationLocation.Method,
- clientDefaultValue: this.interpret.getClientDefault(body?.instance || {}, {})
- }));
- return operation.addRequest(httpRequest);
- }
+ // Convert schema properties into parameters. OpenAPI 3 requires that
+ // multipart/form-data parameters be modeled as object schema properties
+ // but we must turn them back into operation parameters so that code
+ // generators will generate them as method parameters.
+ for (const { key: propertyName, value: propertyDeclaration } of items(requestSchema.instance.properties)) {
+ const property = this.resolve(propertyDeclaration);
+ this.use(<OpenAPI.Refable<OpenAPI.Schema>>propertyDeclaration, (pSchemaName, pSchema) => {
+ const pType = this.processSchema(pSchemaName || `type·for·${propertyName}`, pSchema);
+ httpRequest.addParameter(new Parameter(
+ propertyName,
+ propertyDeclaration.description || this.interpret.getDescription(pType.language.default.description, property),
+ pType, {
+ schema: pType,
+ required:
+ requestSchema.instance?.required
+ && requestSchema.instance?.required.indexOf(propertyName) > -1 ? true : undefined,
+ implementation: ImplementationLocation.Method,
+ extensions: this.interpret.getExtensionProperties(propertyDeclaration),
+ nullable: propertyDeclaration.nullable || pSchema.nullable,
+ protocol: {
+ http: new HttpParameter(ParameterLocation.Body)
+ },
+ language: {
+ default: {
+ name: propertyName,
+ description: propertyDeclaration.description,
+ serializedName: propertyName
+ }
+ },
+ clientDefaultValue: this.interpret.getClientDefault(propertyDeclaration, pSchema)
+ }));
+
+ // Track the usage of this schema as an input with media type
+ this.trackSchemaUsage(pType, { usage: [SchemaContext.Input], serializationFormats: [kmt] });
+ });
+ }
+ } else {
+ const pSchema = this.processSchema(requestSchema?.name || 'requestBody', requestSchema?.instance || <OpenAPI.Schema>{})
+
+ // Track the usage of this schema as an input with media type
+ this.trackSchemaUsage(pSchema, { usage: [SchemaContext.Input], serializationFormats: [kmt] });
+
+ httpRequest.addParameter(new Parameter(
+ body.instance?.['x-ms-requestBody-name'] ?? 'body',
+ this.interpret.getDescription('', body?.instance || {}),
+ pSchema, {
+ extensions: this.interpret.getExtensionProperties(body.instance),
+ required: !!body.instance.required,
+ nullable: requestSchema?.instance?.nullable,
+ protocol: {
+ http: new HttpParameter(ParameterLocation.Body, {
+ style: <SerializationStyle><any>kmt,
+ })
+ },
+ implementation: ImplementationLocation.Method,
+ clientDefaultValue: this.interpret.getClientDefault(body?.instance || {}, {})
+ }));
+ }
 
- processMultipart(kmtMulti: Array<{ mediaType: string; schema: Dereferenced<OpenAPI.Schema | undefined>; }>, operation: Operation, body: Dereferenced<OpenAPI.RequestBody | undefined>) {
- throw new Error('Multipart forms not implemented yet..');
+ return operation.addRequest(httpRequest);
  }
 
  processOperation(httpOperation: OpenAPI.HttpOperation, method: string, path: string, pathItem: OpenAPI.PathItem) {
@@ -1665,7 +1713,7 @@ export class ModelerFour {
  throw new Error(`Requests with 'multipart/formdata' can not be combined in a single operation with other media types ${keys(requestBody.instance.content).toArray()} `);
  }
  // create multipart form upload for this.
- this.processMultipart(kmtMultipart, operation, requestBody);
+ this.processSerializedObject(KnownMediaType.Multipart, kmtMultipart, operation, requestBody);
  }
  // ensure the protocol information is set on the requests
  for (const request of values(operation.requests)) {

modelerfour/test/scenarios/blob-storage/flattened.yaml

@@ -602,6 +602,7 @@ schemas: !<!Schemas>
  xml:
  name: Start
  attribute: false
+ text: false
  wrapped: false
  language: !<!Languages> 
  default:
@@ -615,6 +616,7 @@ schemas: !<!Schemas>
  xml:
  name: End
  attribute: false
+ text: false
  wrapped: false
  language: !<!Languages> 
  default:
@@ -975,6 +977,7 @@ schemas: !<!Schemas>
  serialization:
  xml:
  attribute: true
+ text: false
  wrapped: false
  language: !<!Languages> 
  default:
@@ -1954,6 +1957,7 @@ schemas: !<!Schemas>
  serialization:
  xml:
  attribute: true
+ text: false
  wrapped: false
  language: !<!Languages> 
  default:
@@ -1968,6 +1972,7 @@ schemas: !<!Schemas>
  serialization:
  xml:
  attribute: true
+ text: false
  wrapped: false
  language: !<!Languages> 
  default:
@@ -2153,6 +2158,7 @@ schemas: !<!Schemas>
  serialization:
  xml:
  attribute: true
+ text: false
  wrapped: false
  language: !<!Languages> 
  default:
@@ -2221,6 +2227,7 @@ schemas: !<!Schemas>
  serialization:
  xml:
  attribute: true
+ text: false
  wrapped: false
  language: !<!Languages> 
  default:
@@ -2235,6 +2242,7 @@ schemas: !<!Schemas>
  serialization:
  xml:
  attribute: true
+ text: false
  wrapped: false
  language: !<!Languages> 
  default:
@@ -4839,6 +4847,7 @@ schemas: !<!Schemas>
  xml:
  name: Committed
  attribute: false
+ text: false
  wrapped: false
  language: !<!Languages> 
  default:
@@ -4854,6 +4863,7 @@ schemas: !<!Schemas>
  xml:
  name: Uncommitted
  attribute: false
+ text: false
  wrapped: false
  language: !<!Languages> 
  default:
@@ -4869,6 +4879,7 @@ schemas: !<!Schemas>
  xml:
  name: Latest
  attribute: false
+ text: false
  wrapped: false
  language: !<!Languages> 
  default:
@@ -9546,6 +9557,7 @@ schemas: !<!Schemas>
  serialization:
  xml:
  attribute: false
+ text: false
  wrapped: true
  language: !<!Languages> 
  default:
@@ -9897,6 +9909,7 @@ schemas: !<!Schemas>
  xml:
  name: Container
  attribute: false
+ text: false
  wrapped: false
  serializationFormats:
  - xml
@@ -9912,6 +9925,7 @@ schemas: !<!Schemas>
  xml:
  name: Containers
  attribute: false
+ text: false
  wrapped: true
  language: !<!Languages> 
  default:
@@ -9938,6 +9952,7 @@ schemas: !<!Schemas>
  xml:
  name: EnumerationResults
  attribute: false
+ text: false
  wrapped: false
  serializationFormats:
  - xml
@@ -10135,6 +10150,7 @@ schemas: !<!Schemas>
  xml:
  name: SignedIdentifier
  attribute: false
+ text: false
  wrapped: false
  serializationFormats:
  - xml
@@ -10535,6 +10551,7 @@ schemas: !<!Schemas>
  xml:
  name: Properties
  attribute: false
+ text: false
  wrapped: false
  serializationFormats:
  - xml
@@ -10577,6 +10594,7 @@ schemas: !<!Schemas>
  xml:
  name: Metadata
  attribute: false
+ text: false
  wrapped: false
  serializationFormats:
  - xml
@@ -10599,6 +10617,7 @@ schemas: !<!Schemas>
  xml:
  name: Blob
  attribute: false
+ text: false
  wrapped: false
  serializationFormats:
  - xml
@@ -10626,6 +10645,7 @@ schemas: !<!Schemas>
  xml:
  name: Blobs
  attribute: false
+ text: false
  wrapped: false
  serializationFormats:
  - xml
@@ -10657,6 +10677,7 @@ schemas: !<!Schemas>
  xml:
  name: EnumerationResults
  attribute: false
+ text: false
  wrapped: false
  serializationFormats:
  - xml
@@ -10805,6 +10826,7 @@ schemas: !<!Schemas>
  xml:
  name: Blobs
  attribute: false
+ text: false
  wrapped: false
  serializationFormats:
  - xml
@@ -10836,6 +10858,7 @@ schemas: !<!Schemas>
  xml:
  name: EnumerationResults
  attribute: false
+ text: false
  wrapped: false
  serializationFormats:
  - xml
@@ -10969,6 +10992,7 @@ schemas: !<!Schemas>
  xml:
  name: BlockList
  attribute: false
+ text: false
  wrapped: false
  serializationFormats:
  - xml
@@ -11029,6 +11053,7 @@ schemas: !<!Schemas>
  serialization:
  xml:
  attribute: false
+ text: false
  wrapped: true
  language: !<!Languages> 
  default:
@@ -11051,6 +11076,7 @@ schemas: !<!Schemas>
  serialization:
  xml:
  attribute: false
+ text: false
  wrapped: true
  language: !<!Languages> 
  default:
@@ -11114,6 +11140,7 @@ schemas: !<!Schemas>
  xml:
  name: PageRange
  attribute: false
+ text: false
  wrapped: false
  serializationFormats:
  - xml
@@ -11170,6 +11197,7 @@ schemas: !<!Schemas>
  xml:
  name: ClearRange
  attribute: false
+ text: false
  wrapped: false
  serializationFormats:
  - xml
@@ -11217,6 +11245,7 @@ schemas: !<!Schemas>
  xml:
  name: SignedIdentifiers
  attribute: false
+ text: false
  wrapped: true
  language: !<!Languages> 
  default: