Skip to content

[release/6.0-preview6] Don't add service parameters to an endpoint ApiDescriptions #33728

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
Jun 22, 2021
Merged

[release/6.0-preview6] Don't add service parameters to an endpoint ApiDescriptions #33728

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
13 changes: 12 additions & 1 deletion src/Mvc/Mvc.ApiExplorer/src/EndpointMetadataApiDescriptionProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,11 @@ private ApiDescription CreateApiDescription(RouteEndpoint routeEndpoint, string
{
var parameterDescription = CreateApiParameterDescription(parameter, routeEndpoint.RoutePattern);

if (parameterDescription is null)
{
continue;
}

if (parameterDescription.Source == BindingSource.Body)
{
hasJsonBody = true;
Expand All @@ -118,10 +123,16 @@ private ApiDescription CreateApiDescription(RouteEndpoint routeEndpoint, string
return apiDescription;
}

private ApiParameterDescription CreateApiParameterDescription(ParameterInfo parameter, RoutePattern pattern)
private ApiParameterDescription? CreateApiParameterDescription(ParameterInfo parameter, RoutePattern pattern)
{
var (source, name) = GetBindingSourceAndName(parameter, pattern);

// Services are ignored because they are not request parameters.
if (source == BindingSource.Services)
{
return null;
}

return new ApiParameterDescription
{
Name = name,
Expand Down
18 changes: 5 additions & 13 deletions src/Mvc/Mvc.ApiExplorer/test/EndpointMetadataApiDescriptionProviderTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,20 +248,12 @@ public void AddsFromHeaderParameterAsHeader()
}

[Fact]
public void AddsFromServiceParameterAsService()
public void DoesNotAddFromServiceParameterAsService()
{
static void AssertServiceParameter(ApiDescription apiDescription, Type expectedType)
{
var param = Assert.Single(apiDescription.ParameterDescriptions);
Assert.Equal(expectedType, param.Type);
Assert.Equal(expectedType, param.ModelMetadata.ModelType);
Assert.Equal(BindingSource.Services, param.Source);
}

AssertServiceParameter(GetApiDescription((IInferredServiceInterface foo) => { }), typeof(IInferredServiceInterface));
AssertServiceParameter(GetApiDescription(([FromServices] int foo) => { }), typeof(int));
AssertServiceParameter(GetApiDescription((HttpContext context) => { }), typeof(HttpContext));
AssertServiceParameter(GetApiDescription((CancellationToken token) => { }), typeof(CancellationToken));
Assert.Empty(GetApiDescription((IInferredServiceInterface foo) => { }).ParameterDescriptions);
Assert.Empty(GetApiDescription(([FromServices] int foo) => { }).ParameterDescriptions);
Assert.Empty(GetApiDescription((HttpContext context) => { }).ParameterDescriptions);
Assert.Empty(GetApiDescription((CancellationToken token) => { }).ParameterDescriptions);
}

[Fact]
Expand Down