Skip to content

Fix DescribeAllParametersInCamelCase usage in GenerateOpenApiOperationFromMetadataAsync #3309

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
martincostello merged 1 commit into from
Mar 18, 2025
+70 −0
Merged

Fix DescribeAllParametersInCamelCase usage in GenerateOpenApiOperationFromMetadataAsync #3309

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
1 change: 1 addition & 0 deletions src/Swashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SwaggerGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,7 @@ private async Task<OpenApiOperation> GenerateOpenApiOperationFromMetadataAsync(A
if (apiParameter is not null)
{
var (parameterAndContext, filterContext) = GenerateParameterAndContext(apiParameter, schemaRepository);
parameter.Name = parameterAndContext.Name;
parameter.Schema = parameterAndContext.Schema;
parameter.Description ??= parameterAndContext.Description;

Expand Down
69 changes: 69 additions & 0 deletions test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGenerator/SwaggerGeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1410,6 +1410,75 @@ public void GetSwagger_SupportsOption_DescribeAllParametersInCamelCase(
Assert.Equal(expectedOpenApiParameterName, parameter.Name);
}

[Theory]
[InlineData("SomeParam", "someParam")]
[InlineData("FooBar.SomeParam", "fooBar.someParam")]
[InlineData("A.B", "a.b")]
[InlineData("", "")]
[InlineData(null, null)]
public void GetSwagger_SupportsOption_DescribeAllParametersInCamelCase_ForParametersFromMetadata(
string parameterName,
string expectedOpenApiParameterName)
{
var methodInfo = typeof(FakeController).GetMethod(nameof(FakeController.ActionWithParameter));
var actionDescriptor = new ActionDescriptor
{
EndpointMetadata = new List<object>()
{
new OpenApiOperation
{
OperationId = "OperationIdSetInMetadata",
Parameters = new List<OpenApiParameter>()
{
new OpenApiParameter
{
Name = parameterName
}
}
}
},
RouteValues = new Dictionary<string, string>
{
["controller"] = methodInfo.DeclaringType.Name.Replace("Controller", string.Empty)
}
};
var subject = Subject(
apiDescriptions: new[]
{
ApiDescriptionFactory.Create(
actionDescriptor,
methodInfo,
groupName: "v1",
httpMethod: "POST",
relativePath: "resource",
parameterDescriptions: new[]
{
new ApiParameterDescription
{
Name = parameterName,
Source = BindingSource.Path,
ModelMetadata = ModelMetadataFactory.CreateForType(typeof(string)),
Type = typeof(string)
}
}),
},
options: new SwaggerGeneratorOptions
{
SwaggerDocs = new Dictionary<string, OpenApiInfo>
{
["v1"] = new OpenApiInfo { Version = "V1", Title = "Test API" }
},
DescribeAllParametersInCamelCase = true
}
);

var document = subject.GetSwagger("v1");

var operation = document.Paths["/resource"].Operations[OperationType.Post];
var parameter = Assert.Single(operation.Parameters);
Assert.Equal(expectedOpenApiParameterName, parameter.Name);
}

[Fact]
public void GetSwagger_SupportsOption_Servers()
{
Expand Down