Skip to content

Propagate PropertyInfo for AsParameters parameters #57264

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 3 commits into from
Aug 20, 2024
Merged

Propagate PropertyInfo for AsParameters parameters #57264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
30eca89
Propagate PropertyInfo for AsParameters parameters
Aug 10, 2024
44e21c9
Apply PR suggestions
Aug 15, 2024
a0d91ee
Better with previous implementation but taking into account parameter
Aug 19, 2024
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
15 changes: 14 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 @@ -188,7 +188,7 @@ private ApiDescription CreateApiDescription(RouteEndpoint routeEndpoint, string
return new ApiParameterDescription
{
Name = name,
ModelMetadata = CreateModelMetadata(paramType),
ModelMetadata = CreateModelMetadata(parameter, paramType),
Source = source,
DefaultValue = parameter.ParameterInfo.DefaultValue,
Type = parameter.ParameterInfo.ParameterType,
Expand Down Expand Up @@ -436,6 +436,19 @@ private static ApiResponseType CreateDefaultApiResponseType(Type responseType)
private static EndpointModelMetadata CreateModelMetadata(Type type) =>
new(ModelMetadataIdentity.ForType(type));

private static EndpointModelMetadata CreateModelMetadata(IParameterBindingMetadata parameter, Type type)
{
if (parameter.ParameterInfo is { } parameterInfo)
{
if (parameterInfo.Member is PropertyInfo propertyInfo && propertyInfo.DeclaringType is not null)
{
return new(ModelMetadataIdentity.ForProperty(propertyInfo, type, propertyInfo.DeclaringType));
}
return new(ModelMetadataIdentity.ForParameter(parameterInfo, type));
}
return CreateModelMetadata(type);
}

private static void AddResponseContentTypes(IList<ApiResponseFormat> apiResponseFormats, IReadOnlyList<string> contentTypes)
{
foreach (var contentType in contentTypes)
Expand Down
23 changes: 17 additions & 6 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 @@ -385,12 +385,13 @@ public void AddsMultipleResponseFormatsFromMetadataWithAwaitableResultType()
var apiDescription = GetApiDescription(
[ProducesResponseType(typeof(InferredJsonClass), StatusCodes.Status201Created)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
async Task<Results<Created<InferredJsonClass>, ProblemHttpResult>> () => {
await Task.CompletedTask;
return Random.Shared.Next() % 2 == 0
? TypedResults.Created<InferredJsonClass>("/", new InferredJsonClass())
: TypedResults.Problem();
});
async Task<Results<Created<InferredJsonClass>, ProblemHttpResult>> () =>
{
await Task.CompletedTask;
return Random.Shared.Next() % 2 == 0
? TypedResults.Created<InferredJsonClass>("/", new InferredJsonClass())
: TypedResults.Problem();
});

Assert.Equal(2, apiDescription.SupportedResponseTypes.Count);

Expand Down Expand Up @@ -706,6 +707,16 @@ public void SupportsRequiredMembersInAsParametersAttribute()
param => Assert.False(param.IsRequired));
}

[Fact]
public void SupportsContainerTypeInAsParametersAttribute()
{
var apiDescription = GetApiDescription(([AsParameters] AsParametersWithRequiredMembers foo) => { });
Assert.Equal(4, apiDescription.ParameterDescriptions.Count);

Assert.NotNull(apiDescription.ParameterDescriptions[0].ModelMetadata.ContainerType);
Assert.Equal(typeof(AsParametersWithRequiredMembers), apiDescription.ParameterDescriptions[0].ModelMetadata.ContainerType);
}

#nullable disable
public class AsParametersWithRequiredMembersObliviousContext
{
Expand Down
Loading