[OpenAPI] Get parameter description with [FromQuery] (#62986)

* [OpenAPI] Get description with [FromQuery]

Get the description from the associated object's property when `[FromQuery]` is applied to a property of an object used as a `[FromQuery]` parameter.

Resolves #61297.

* [OpenAPI] Get default value with [FromQuery]

Get the default value from the associated object's property when `[FromQuery]` is applied to a property of an object used as a `[FromQuery]` parameter.

Resolves #61934.

Author: martincostello

src/OpenApi/src/Extensions/JsonNodeSchemaExtensions.cs

@@ -329,6 +329,11 @@ internal static void ApplyParameterInfo(this JsonNode schema, ApiParameterDescri
             var attributes = validations.OfType<ValidationAttribute>();
             schema.ApplyValidationAttributes(attributes);
         }
+        if (parameterDescription.ModelMetadata is Mvc.ModelBinding.Metadata.DefaultModelMetadata { Attributes.PropertyAttributes.Count: > 0 } metadata &&
+            metadata.Attributes.PropertyAttributes.OfType<DefaultValueAttribute>().LastOrDefault() is { } metadataDefaultValueAttribute)
+        {
+            schema.ApplyDefaultValue(metadataDefaultValueAttribute.Value, jsonTypeInfo);
+        }
         if (parameterDescription.ParameterDescriptor is IParameterInfoParameterDescriptor { ParameterInfo: { } parameterInfo })
         {
             if (parameterInfo.HasDefaultValue)

src/OpenApi/src/Services/OpenApiDocumentService.cs

@@ -506,11 +506,22 @@ private static bool IsRequired(ApiParameterDescription parameter)
     }
 
     // Apply [Description] attributes on the parameter to the top-level OpenApiParameter object and not the schema.
-    private static string? GetParameterDescriptionFromAttribute(ApiParameterDescription parameter) =>
-        parameter.ParameterDescriptor is IParameterInfoParameterDescriptor { ParameterInfo: { } parameterInfo } &&
-        parameterInfo.GetCustomAttributes().OfType<DescriptionAttribute>().LastOrDefault() is { } descriptionAttribute ?
-            descriptionAttribute.Description :
-            null;
+    private static string? GetParameterDescriptionFromAttribute(ApiParameterDescription parameter)
+    {
+        if (parameter.ParameterDescriptor is IParameterInfoParameterDescriptor { ParameterInfo: { } parameterInfo } &&
+            parameterInfo.GetCustomAttributes<DescriptionAttribute>().LastOrDefault() is { } parameterDescription)
+        {
+            return parameterDescription.Description;
+        }
+
+        if (parameter.ModelMetadata is Mvc.ModelBinding.Metadata.DefaultModelMetadata { Attributes.PropertyAttributes.Count: > 0 } metadata &&
+            metadata.Attributes.PropertyAttributes.OfType<DescriptionAttribute>().LastOrDefault() is { } propertyDescription)
+        {
+            return propertyDescription.Description;
+        }
+
+        return null;
+    }
 
     private async Task<OpenApiRequestBody?> GetRequestBodyAsync(OpenApiDocument document, ApiDescription description, IServiceProvider scopedServiceProvider, IOpenApiSchemaTransformer[] schemaTransformers, CancellationToken cancellationToken)
     {

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiDocumentServiceTestsBase.cs

@@ -229,7 +229,7 @@ public ControllerActionDescriptor CreateActionDescriptor(string methodName = nul
 
         action.AttributeRouteInfo = new()
         {
-            Template = action.MethodInfo.GetCustomAttribute<RouteAttribute>()?.Template,
+            Template = action.MethodInfo.GetCustomAttribute<RouteAttribute>()?.Template ?? string.Empty,
             Name = action.MethodInfo.GetCustomAttribute<RouteAttribute>()?.Name,
             Order = action.MethodInfo.GetCustomAttribute<RouteAttribute>()?.Order ?? 0,
         };

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs

@@ -509,6 +509,86 @@ await VerifyOpenApiDocument(builder, document =>
         });
     }
 
+    [Fact]
+    public async Task GetOpenApiParameters_HandlesAsParametersParametersWithDescriptionAttribute()
+    {
+        // Arrange
+        var builder = CreateBuilder();
+
+        // Act
+        builder.MapGet("/api", ([AsParameters] FromQueryModel model) => { });
+
+        // Assert
+        await VerifyOpenApiDocument(builder, document =>
+        {
+            var operation = document.Paths["/api"].Operations[HttpMethod.Get];
+            Assert.Contains(operation.Parameters, actualMemory => actualMemory.Name == "id" && actualMemory.Description == "The ID of the entity");
+        });
+    }
+
+    [Fact]
+    public async Task GetOpenApiParameters_HandlesFromQueryParametersWithDescriptionAttribute()
+    {
+        // Arrange
+        var actionDescriptor = CreateActionDescriptor(nameof(TestFromQueryController.GetWithFromQueryDto), typeof(TestFromQueryController));
+
+        // Assert
+        await VerifyOpenApiDocument(actionDescriptor, document =>
+        {
+            var operation = document.Paths["/"].Operations[HttpMethod.Get];
+            Assert.Contains(operation.Parameters, actualMemory => actualMemory.Name == "id" && actualMemory.Description == "The ID of the entity");
+        });
+    }
+
+    [Fact]
+    public async Task GetOpenApiParameters_HandlesAsParametersParametersWithDefaultValueAttribute()
+    {
+        // Arrange
+        var builder = CreateBuilder();
+
+        // Act
+        builder.MapGet("/api", ([AsParameters] FromQueryModel model) => { });
+
+        // Assert
+        await VerifyOpenApiDocument(builder, document =>
+        {
+            var operation = document.Paths["/api"].Operations[HttpMethod.Get];
+            Assert.Contains(
+                operation.Parameters,
+                actualMemory =>
+                {
+                    return actualMemory.Name == "limit" &&
+                           actualMemory.Schema != null &&
+                           actualMemory.Schema.Default != null &&
+                           actualMemory.Schema.Default.GetValueKind() == JsonValueKind.Number &&
+                           actualMemory.Schema.Default.GetValue<int>() == 20;
+                });
+        });
+    }
+
+    [Fact]
+    public async Task GetOpenApiParameters_HandlesFromQueryParametersWithDefaultValueAttribute()
+    {
+        // Arrange
+        var actionDescriptor = CreateActionDescriptor(nameof(TestFromQueryController.GetWithFromQueryDto), typeof(TestFromQueryController));
+
+        // Assert
+        await VerifyOpenApiDocument(actionDescriptor, document =>
+        {
+            var operation = document.Paths["/"].Operations[HttpMethod.Get];
+            Assert.Contains(
+                operation.Parameters,
+                actualMemory =>
+                {
+                    return actualMemory.Name == "limit" &&
+                           actualMemory.Schema != null &&
+                           actualMemory.Schema.Default != null &&
+                           actualMemory.Schema.Default.GetValueKind() == JsonValueKind.Number &&
+                           actualMemory.Schema.Default.GetValue<int>() == 20;
+                });
+        });
+    }
+
     [Route("/api/{id}/{date}")]
     private void AcceptsParametersInModel(RouteParamsContainer model) { }
 
@@ -809,4 +889,28 @@ public override void Write(Utf8JsonWriter writer, EnumArrayType value, JsonSeria
             writer.WriteEndObject();
         }
     }
+
+    [ApiController]
+    [Route("[controller]/[action]")]
+    private class TestFromQueryController : ControllerBase
+    {
+        [HttpGet]
+        public Task<IActionResult> GetWithFromQueryDto([FromQuery] FromQueryModel query)
+        {
+            return Task.FromResult<IActionResult>(Ok());
+        }
+    }
+
+    [Description("A query model.")]
+    private record FromQueryModel
+    {
+        [Description("The ID of the entity")]
+        [FromQuery(Name = "id")]
+        public int Id { get; set; }
+
+        [Description("The maximum number of results")]
+        [FromQuery(Name = "limit")]
+        [DefaultValue(20)]
+        public int Limit { get; set; }
+    }
 }