Skip to content

Fix formData/body parameter and consumes handling #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 22, 2018
Merged

Fix formData/body parameter and consumes handling #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 28 additions & 15 deletions src/Microsoft.OpenApi.Readers/V2/OpenApiOperationDeserializer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,15 @@ internal static partial class OpenApiV2Deserializer
{s => s.StartsWith("x-"), (o, p, n) => o.AddExtension(p, n.CreateAny())}
};

private static FixedFieldMap<OpenApiResponses> _responsesFixedFields = new FixedFieldMap<OpenApiResponses>();
private static readonly FixedFieldMap<OpenApiResponses> _responsesFixedFields =
new FixedFieldMap<OpenApiResponses>();

private static PatternFieldMap<OpenApiResponses> _responsesPatternFields = new PatternFieldMap<OpenApiResponses>
{
{s => !s.StartsWith("x-"), (o, p, n) => o.Add(p, LoadResponse(n))},
{s => s.StartsWith("x-"), (o, p, n) => o.AddExtension(p, n.CreateAny())}
};
private static readonly PatternFieldMap<OpenApiResponses> _responsesPatternFields =
new PatternFieldMap<OpenApiResponses>
{
{s => !s.StartsWith("x-"), (o, p, n) => o.Add(p, LoadResponse(n))},
{s => s.StartsWith("x-"), (o, p, n) => o.AddExtension(p, n.CreateAny())}
};

internal static OpenApiOperation LoadOperation(ParseNode node)
{
Expand All @@ -119,7 +121,7 @@ internal static OpenApiOperation LoadOperation(ParseNode node)
var formParameters = node.Context.GetFromTempStorage<List<OpenApiParameter>>("formParameters");
if (formParameters != null)
{
operation.RequestBody = CreateFormBody(formParameters);
operation.RequestBody = CreateFormBody(node.Context, formParameters);
}
}

Expand All @@ -137,22 +139,33 @@ public static OpenApiResponses LoadResponses(ParseNode node)
return domainObject;
}

private static OpenApiRequestBody CreateFormBody(List<OpenApiParameter> formParameters)
private static OpenApiRequestBody CreateFormBody(ParsingContext context, List<OpenApiParameter> formParameters)
{
var mediaType = new OpenApiMediaType
{
Schema = new OpenApiSchema
{
Properties = formParameters.ToDictionary(k => k.Name, v => v.Schema)
Properties = formParameters.ToDictionary(
k => k.Name,
v =>
{
var schema = v.Schema;
schema.Description = v.Description;
return schema;
}),
Required = formParameters.Where(p => p.Required).Select(p => p.Name).ToList()
}
};

var consumes = context.GetFromTempStorage<List<string>>("operationconsumes") ??
Copy link
Member

@darrelmiller darrelmiller Jan 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is worth noting that this will import a valid V2 document correctly, but it will also create an invalid DOM if the media type is not a valid one. Validating this is going to be tricky, so I'm ok if we punt on checking for that.

Copy link
Contributor Author

@PerthCharern PerthCharern Jan 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree. It’s a bit complicated to add “validation logic” into the reader at this point. I’d rather wait for your PR to be completed and we can retroactively clean-up these validation grey areas later.

context.GetFromTempStorage<List<string>>("globalconsumes") ??
new List<string> {"application/x-www-form-urlencoded"};

var formBody = new OpenApiRequestBody
{
Content = new Dictionary<string, OpenApiMediaType>
{
{"application/x-www-form-urlencoded", mediaType}
}
Content = consumes.ToDictionary(
k => k,
v => mediaType)
};

return formBody;
Expand All @@ -162,8 +175,8 @@ private static OpenApiRequestBody CreateRequestBody(
ParsingContext context,
OpenApiParameter bodyParameter)
{
var consumes = context.GetFromTempStorage<List<string>>("operationproduces") ??
context.GetFromTempStorage<List<string>>("globalproduces") ?? new List<string> {"application/json"};
var consumes = context.GetFromTempStorage<List<string>>("operationconsumes") ??
context.GetFromTempStorage<List<string>>("globalconsumes") ?? new List<string> {"application/json"};

var requestBody = new OpenApiRequestBody
{
Expand Down
38 changes: 29 additions & 9 deletions src/Microsoft.OpenApi/Models/OpenApiOperation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,16 +222,36 @@ public void SerializeAsV2(IOpenApiWriter writer)

writer.WriteEndArray();

// Create a parameter as BodyParameter type and add to Parameters.
// This type will be used to populate the In property as "body" when Parameters is serialized.
var bodyParameter = new BodyParameter
// This is form data. We need to split the request body into multiple parameters.
if (consumes.Contains("application/x-www-form-urlencoded") ||
consumes.Contains("multipart/form-data"))
{
Description = RequestBody.Description,
Schema = RequestBody.Content.First().Value.Schema,
Format = new List<string>(consumes)
};

parameters.Add(bodyParameter);
foreach (var property in RequestBody.Content.First().Value.Schema.Properties)
{
parameters.Add(
new OpenApiFormDataParameter
{
Description = property.Value.Description,
Name = property.Key,
Schema = property.Value,
Required = RequestBody.Content.First().Value.Schema.Required.Contains(property.Key)
});
}
}
else
{
var bodyParameter = new OpenApiBodyParameter
{
Description = RequestBody.Description,
// V2 spec actually allows the body to have custom name.
// Our library does not support this at the moment.
Name = "body",
Schema = RequestBody.Content.First().Value.Schema,
Required = RequestBody.Required
};

parameters.Add(bodyParameter);
}
}

if (Responses != null)
Expand Down
54 changes: 14 additions & 40 deletions src/Microsoft.OpenApi/Models/OpenApiParameter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,24 +221,23 @@ public void SerializeAsV2WithoutReference(IOpenApiWriter writer)
{
writer.WriteStartObject();

// name
// in
if (IsFormDataParameter())
if (this is OpenApiFormDataParameter)
{
writer.WriteProperty(OpenApiConstants.Name, "formData");
writer.WriteProperty(OpenApiConstants.In, "formData");
}
else if (IsBodyParameter())
else if (this is OpenApiBodyParameter)
{
writer.WriteProperty(OpenApiConstants.Name, "body");
writer.WriteProperty(OpenApiConstants.In, "body");
}
else
{
writer.WriteProperty(OpenApiConstants.Name, Name);
writer.WriteProperty(OpenApiConstants.In, In.GetDisplayName());
}

// name
writer.WriteProperty(OpenApiConstants.Name, Name);

// description
writer.WriteProperty(OpenApiConstants.Description, Description);

Expand All @@ -249,7 +248,7 @@ public void SerializeAsV2WithoutReference(IOpenApiWriter writer)
writer.WriteProperty(OpenApiConstants.Deprecated, Deprecated, false);

// schema
if (IsBodyParameter())
if (this is OpenApiBodyParameter)
{
writer.WriteOptionalObject(OpenApiConstants.Schema, Schema, (w, s) => s.SerializeAsV2(w));
}
Expand Down Expand Up @@ -283,44 +282,19 @@ public void SerializeAsV2WithoutReference(IOpenApiWriter writer)

writer.WriteEndObject();
}

private bool IsBodyParameter()
{
if (this is BodyParameter)
{
var parameter = (BodyParameter)this;

return !(
parameter.Format.Contains("application/x-www-form-urlencoded") ||
parameter.Format.Contains("multipart/form-data"));
}

return false;
}

private bool IsFormDataParameter()
{
if (this is BodyParameter)
{
var parameter = (BodyParameter)this;

return
parameter.Format.Contains("application/x-www-form-urlencoded") ||
parameter.Format.Contains("multipart/form-data");
}

return false;
}
}

/// <summary>
/// Body parameter class to propagate information needed for <see cref="OpenApiParameter.SerializeAsV2"/>
/// </summary>
internal class BodyParameter : OpenApiParameter
internal class OpenApiBodyParameter : OpenApiParameter
{
}

/// <summary>
/// Form parameter class to propagate information needed for <see cref="OpenApiParameter.SerializeAsV2"/>
/// </summary>
internal class OpenApiFormDataParameter : OpenApiParameter
{
/// <summary>
/// Format of the parameter. This should be the same as the "consumes" property in Operation.
/// </summary>
public IList<string> Format { get; set; }
}
}
9 changes: 9 additions & 0 deletions test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@
<EmbeddedResource Include="V2Tests\Samples\minimal.v3.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V2Tests\Samples\OpenApiOperation\basicOperation.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V2Tests\Samples\OpenApiOperation\operationWithBody.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V2Tests\Samples\OpenApiOperation\operationWithFormData.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V2Tests\Samples\OpenApiParameter\bodyParameter.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
Expand Down
Loading