Skip to content

[release/7.0] Don't generate RequestBody for parameters when disabledInferredBody is true #47807

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
May 8, 2023
Merged

[release/7.0] Don't generate RequestBody for parameters when disabledInferredBody is true #47807

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
6 changes: 3 additions & 3 deletions src/OpenApi/src/OpenApiGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ private OpenApiOperation GetOperation(string httpMethod, MethodInfo methodInfo,
Description = metadata.GetMetadata<IEndpointDescriptionMetadata>()?.Description,
Tags = GetOperationTags(methodInfo, metadata),
Parameters = GetOpenApiParameters(methodInfo, pattern, disableInferredBody),
RequestBody = GetOpenApiRequestBody(methodInfo, metadata, pattern),
RequestBody = GetOpenApiRequestBody(methodInfo, metadata, pattern, disableInferredBody),
Responses = GetOpenApiResponses(methodInfo, metadata)
};

Expand Down Expand Up @@ -251,15 +251,15 @@ private static void GenerateDefaultResponses(Dictionary<int, (Type?, MediaTypeCo
}
}

private OpenApiRequestBody? GetOpenApiRequestBody(MethodInfo methodInfo, EndpointMetadataCollection metadata, RoutePattern pattern)
private OpenApiRequestBody? GetOpenApiRequestBody(MethodInfo methodInfo, EndpointMetadataCollection metadata, RoutePattern pattern, bool disableInferredBody)
{
var hasFormOrBodyParameter = false;
ParameterInfo? requestBodyParameter = null;

var parameters = PropertyAsParameterInfo.Flatten(methodInfo.GetParameters(), ParameterBindingMethodCache);
foreach (var parameter in parameters)
{
var (bodyOrFormParameter, _, _) = GetOpenApiParameterLocation(parameter, pattern, false);
var (bodyOrFormParameter, _, _) = GetOpenApiParameterLocation(parameter, pattern, disableInferredBody);
hasFormOrBodyParameter |= bodyOrFormParameter;
if (hasFormOrBodyParameter)
{
Expand Down
12 changes: 12 additions & 0 deletions src/OpenApi/test/OpenApiGeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -928,6 +928,18 @@ static void ValidateParameter(OpenApiOperation operation, string expectedName)
ValidateParameter(GetOpenApiOperation(([FromHeader(Name = "headerName")] string param) => ""), "headerName");
}

[Fact]
public void DoesNotGenerateRequestBodyWhenInferredBodyDisabled()
{
var operation = GetOpenApiOperation((string[] names) => { }, httpMethods: new[] { "GET" });

var parameter = Assert.Single(operation.Parameters);

Assert.Equal("names", parameter.Name);
Assert.Equal(ParameterLocation.Query, parameter.In);
Assert.Null(operation.RequestBody);
}

private static OpenApiOperation GetOpenApiOperation(
Delegate action,
string pattern = null,
Expand Down