Skip to content

Serialize explode value properly on parameters with style "form" #404

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
darrelmiller merged 1 commit into from
Aug 22, 2019
Merged

Serialize explode value properly on parameters with style "form" #404

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
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi/Models/OpenApiParameter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ public void SerializeAsV3WithoutReference(IOpenApiWriter writer)
writer.WriteProperty(OpenApiConstants.Style, Style?.GetDisplayName());

// explode
writer.WriteProperty(OpenApiConstants.Explode, Explode, false);
writer.WriteProperty(OpenApiConstants.Explode, Explode, Style.HasValue && Style.Value == ParameterStyle.Form);

// allowReserved
writer.WriteProperty(OpenApiConstants.AllowReserved, AllowReserved, false);
Expand Down
114 changes: 114 additions & 0 deletions test/Microsoft.OpenApi.Tests/Models/OpenApiParameterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
using System.Globalization;
using System.IO;
using FluentAssertions;
using Microsoft.OpenApi.Any;
using Microsoft.OpenApi.Extensions;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.Writers;
Expand Down Expand Up @@ -58,6 +59,50 @@ public class OpenApiParameterTests
}
};

public static OpenApiParameter ParameterWithFormStyleAndExplodeFalse = new OpenApiParameter
{
Name = "name1",
In = ParameterLocation.Query,
Description = "description1",
Style = ParameterStyle.Form,
Explode = false,
Schema = new OpenApiSchema
{
Type = "array",
Items = new OpenApiSchema
{
Enum = new List<IOpenApiAny>
{
new OpenApiString("value1"),
new OpenApiString("value2")
}
}
}

};

public static OpenApiParameter ParameterWithFormStyleAndExplodeTrue = new OpenApiParameter
{
Name = "name1",
In = ParameterLocation.Query,
Description = "description1",
Style = ParameterStyle.Form,
Explode = true,
Schema = new OpenApiSchema
{
Type = "array",
Items = new OpenApiSchema
{
Enum = new List<IOpenApiAny>
{
new OpenApiString("value1"),
new OpenApiString("value2")
}
}
}

};

public static OpenApiParameter AdvancedHeaderParameterWithSchemaReference = new OpenApiParameter
{
Name = "name1",
Expand Down Expand Up @@ -309,5 +354,74 @@ public void SerializeParameterWithSchemaTypeObjectAsV2JsonWorks()
expected = expected.MakeLineBreaksEnvironmentNeutral();
actual.Should().Be(expected);
}

[Fact]
public void SerializeParameterWithFormStyleAndExplodeFalseWorks()
{
// Arrange
var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
var writer = new OpenApiJsonWriter(outputStringWriter);
var expected =
@"{
""name"": ""name1"",
""in"": ""query"",
""description"": ""description1"",
""style"": ""form"",
""explode"": false,
""schema"": {
""type"": ""array"",
""items"": {
""enum"": [
""value1"",
""value2""
]
}
}
}";

// Act
ParameterWithFormStyleAndExplodeFalse.SerializeAsV3WithoutReference(writer);
writer.Flush();
var actual = outputStringWriter.GetStringBuilder().ToString();

// Assert
actual = actual.MakeLineBreaksEnvironmentNeutral();
expected = expected.MakeLineBreaksEnvironmentNeutral();
actual.Should().Be(expected);
}

[Fact]
public void SerializeParameterWithFormStyleAndExplodeTrueWorks()
{
// Arrange
var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
var writer = new OpenApiJsonWriter(outputStringWriter);
var expected =
@"{
""name"": ""name1"",
""in"": ""query"",
""description"": ""description1"",
""style"": ""form"",
""schema"": {
""type"": ""array"",
""items"": {
""enum"": [
""value1"",
""value2""
]
}
}
}";

// Act
ParameterWithFormStyleAndExplodeTrue.SerializeAsV3WithoutReference(writer);
writer.Flush();
var actual = outputStringWriter.GetStringBuilder().ToString();

// Assert
actual = actual.MakeLineBreaksEnvironmentNeutral();
expected = expected.MakeLineBreaksEnvironmentNeutral();
actual.Should().Be(expected);
}
}
}