Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,10 @@ private void ApplyParamTags(IOpenApiParameter parameter, ParameterFilterContext

if (parameter is OpenApiParameter concrete)
{
var example = paramNode.GetAttribute("example");
if (!string.IsNullOrEmpty(example))
var example = paramNode.SelectSingleNode("@example");
if (example != null)
{
concrete.Example = XmlCommentsExampleHelper.Create(context.SchemaRepository, parameter.Schema, example);
concrete.Example = XmlCommentsExampleHelper.Create(context.SchemaRepository, parameter.Schema, example.ToString());
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,10 @@ public void ActionWithSummaryAndResponseTags(T param)
}

/// <param name="param1" example="Example for &quot;param1&quot;">Description for param1</param>
/// <param name="param2" example="Example for &quot;param2&quot;">Description for param2</param>
public void ActionWithParamTags(T param1, T param2)
/// <param name="param2" example="http://test.com/?param1=1&amp;param2=2">Description for param2</param>
/// <param name="param3" example="">Description for param3 with empty example</param>
/// <param name="param4"></param>
public void ActionWithParamTags(T param1, T param2, T param3, T param4)
{
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ public void ActionWithSummaryAndRemarksTags()

/// <param name="param1" example="Example for &quot;param1&quot;">Description for param1</param>
/// <param name="param2" example="http://test.com/?param1=1&amp;param2=2">Description for param2</param>
public void ActionWithParamTags(string param1, string param2)
/// <param name="param3" example="">Description for param3 with empty example</param>
/// <param name="param4"></param>
public void ActionWithParamTags(string param1, string param2, string param3, string param4)
{
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,58 +9,44 @@ namespace Swashbuckle.AspNetCore.SwaggerGen.Test;

public class XmlCommentsParameterFilterTests
{
[Fact]
public void Apply_SetsDescriptionAndExample_FromActionParamTag()
{
var parameter = new OpenApiParameter { Schema = new OpenApiSchema { Type = JsonSchemaTypes.String } };
var parameterInfo = typeof(FakeControllerWithXmlComments)
.GetMethod(nameof(FakeControllerWithXmlComments.ActionWithParamTags))
.GetParameters()[0];
var apiParameterDescription = new ApiParameterDescription { };
var filterContext = new ParameterFilterContext(apiParameterDescription, null, null, null, parameterInfo: parameterInfo);

Subject().Apply(parameter, filterContext);

Assert.Equal("Description for param1", parameter.Description);
Assert.NotNull(parameter.Example);

Assert.Equal("\"Example for \\u0022param1\\u0022\"", parameter.Example.ToJson());
}

[Fact]
public void Apply_SetsDescriptionAndExample_FromUriTypeActionParamTag()
[Theory]
[InlineData(0, "Description for param1", "\"Example for \\u0022param1\\u0022\"")]
[InlineData(1, "Description for param2", "\"http://test.com/?param1=1\\u0026param2=2\"")]
[InlineData(2, "Description for param3 with empty example", "\"\"")]
[InlineData(3, "", null)]
public void Apply_SetsDescriptionAndExample_FromActionParamTag(int p, string expectedDescription, string expectedExample)
{
var parameter = new OpenApiParameter { Schema = new OpenApiSchema { Type = JsonSchemaTypes.String } };
var parameterInfo = typeof(FakeControllerWithXmlComments)
.GetMethod(nameof(FakeControllerWithXmlComments.ActionWithParamTags))
.GetParameters()[1];
.GetParameters()[p];
var apiParameterDescription = new ApiParameterDescription { };
var filterContext = new ParameterFilterContext(apiParameterDescription, null, null, null, parameterInfo: parameterInfo);

Subject().Apply(parameter, filterContext);

Assert.Equal("Description for param2", parameter.Description);
Assert.NotNull(parameter.Example);

Assert.Equal("\"http://test.com/?param1=1\\u0026param2=2\"", parameter.Example.ToJson());
Assert.Equal(expectedDescription, parameter.Description);
Assert.Equal(expectedExample, parameter.Example?.ToJson());
}

[Fact]
public void Apply_SetsDescriptionAndExample_FromUnderlyingGenericTypeActionParamTag()
[Theory]
[InlineData(0, "Description for param1", "\"Example for \\u0022param1\\u0022\"")]
[InlineData(1, "Description for param2", "\"http://test.com/?param1=1\\u0026param2=2\"")]
[InlineData(2, "Description for param3 with empty example", "\"\"")]
[InlineData(3, "", null)]
public void Apply_SetsDescriptionAndExample_FromUnderlyingGenericTypeActionParamTag(int p, string expectedDescription, string expectedExample)
{
var parameter = new OpenApiParameter { Schema = new OpenApiSchema { Type = JsonSchemaTypes.String } };
var parameterInfo = typeof(FakeConstructedControllerWithXmlComments)
.GetMethod(nameof(FakeConstructedControllerWithXmlComments.ActionWithParamTags))
.GetParameters()[0];
.GetParameters()[p];
var apiParameterDescription = new ApiParameterDescription { };
var filterContext = new ParameterFilterContext(apiParameterDescription, null, null, null, parameterInfo: parameterInfo);

Subject().Apply(parameter, filterContext);

Assert.Equal("Description for param1", parameter.Description);
Assert.NotNull(parameter.Example);

Assert.Equal("\"Example for \\u0022param1\\u0022\"", parameter.Example.ToJson());
Assert.Equal(expectedDescription, parameter.Description);
Assert.Equal(expectedExample, parameter.Example?.ToJson());
}

[Fact]
Expand Down
Loading