Skip to content

Query Parameters Serialization - Explode doesn't respect the default value #544

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 2 commits into from
Mar 14, 2021
Merged

Query Parameters Serialization - Explode doesn't respect the default value #544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18f2a11
When the style property on an OpenApiParameter is 'form' then the def…
simon-pearson-lmk Jan 21, 2021
bd10f4a
Merge branch 'vnext' into feature/explode-default-value
darrelmiller Mar 14, 2021
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
8 changes: 7 additions & 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 @@ -14,6 +14,8 @@ namespace Microsoft.OpenApi.Models
/// </summary>
public class OpenApiParameter : IOpenApiSerializable, IOpenApiReferenceable, IOpenApiExtensible
{
private bool? _explode;

/// <summary>
/// Indicates if object is populated with data or is just a reference to the data
/// </summary>
Expand Down Expand Up @@ -79,7 +81,11 @@ public class OpenApiParameter : IOpenApiSerializable, IOpenApiReferenceable, IOp
/// When style is form, the default value is true.
/// For all other styles, the default value is false.
/// </summary>
public bool Explode { get; set; }
public bool Explode
{
get => _explode ?? Style == ParameterStyle.Form;
set => _explode = value;
}

/// <summary>
/// Determines whether the parameter value SHOULD allow reserved characters,
Expand Down
18 changes: 18 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 @@ -163,6 +163,24 @@ public OpenApiParameterTests(ITestOutputHelper output)
_output = output;
}

[Theory]
[InlineData(ParameterStyle.Form, true)]
[InlineData(ParameterStyle.SpaceDelimited, false)]
[InlineData(null, false)]
public void WhenStyleIsFormTheDefaultValueOfExplodeShouldBeTrueOtherwiseFalse(ParameterStyle? style, bool expectedExplode)
{
// Arrange
var parameter = new OpenApiParameter
{
Name = "name1",
In = ParameterLocation.Query,
Style = style
};

// Act & Assert
parameter.Explode.Should().Be(expectedExplode);
}

[Fact]
public void SerializeBasicParameterAsV3JsonWorks()
{
Expand Down