fix: schema handling for collection types (#60460)

xC0dex · web-flow · commit 54cec2ea66fd · 2025-02-18T08:47:57.000-08:00
diff --git a/src/OpenApi/src/Extensions/JsonNodeSchemaExtensions.cs b/src/OpenApi/src/Extensions/JsonNodeSchemaExtensions.cs
@@ -115,24 +115,20 @@ internal static void ApplyValidationAttributes(this JsonNode schema, IEnumerable
             }
             else if (attribute is MaxLengthAttribute maxLengthAttribute)
             {
-                var targetKey = schema[OpenApiSchemaKeywords.TypeKeyword]?.GetValue<string>() == "array" ? OpenApiSchemaKeywords.MaxItemsKeyword : OpenApiSchemaKeywords.MaxLengthKeyword;
-                schema[targetKey] = maxLengthAttribute.Length;
+                var isArray = MapJsonNodeToSchemaType(schema[OpenApiSchemaKeywords.TypeKeyword]) is { } schemaTypes && schemaTypes.HasFlag(JsonSchemaType.Array);
+                var key = isArray ? OpenApiSchemaKeywords.MaxItemsKeyword : OpenApiSchemaKeywords.MaxLengthKeyword;
+                schema[key] = maxLengthAttribute.Length;
             }
             else if (attribute is MinLengthAttribute minLengthAttribute)
             {
-                if (MapJsonNodeToSchemaType(schema[OpenApiSchemaKeywords.TypeKeyword]) is { } schemaTypes &&
-                    schemaTypes.HasFlag(JsonSchemaType.Array))
-                {
-                    schema[OpenApiSchemaKeywords.MinItemsKeyword] = minLengthAttribute.Length;
-                }
-                else
-                {
-                    schema[OpenApiSchemaKeywords.MinLengthKeyword] = minLengthAttribute.Length;
-                }
+                var isArray = MapJsonNodeToSchemaType(schema[OpenApiSchemaKeywords.TypeKeyword]) is { } schemaTypes && schemaTypes.HasFlag(JsonSchemaType.Array);
+                var key = isArray ? OpenApiSchemaKeywords.MinItemsKeyword : OpenApiSchemaKeywords.MinLengthKeyword;
+                schema[key] = minLengthAttribute.Length;
             }
             else if (attribute is LengthAttribute lengthAttribute)
             {
-                var targetKeySuffix = schema[OpenApiSchemaKeywords.TypeKeyword]?.GetValue<string>() == "array" ? "Items" : "Length";
+                var isArray = MapJsonNodeToSchemaType(schema[OpenApiSchemaKeywords.TypeKeyword]) is { } schemaTypes && schemaTypes.HasFlag(JsonSchemaType.Array);
+                var targetKeySuffix = isArray ? "Items" : "Length";
                 schema[$"min{targetKeySuffix}"] = lengthAttribute.MinimumLength;
                 schema[$"max{targetKeySuffix}"] = lengthAttribute.MaximumLength;
             }
diff --git a/src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.RequestBodySchemas.cs b/src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.RequestBodySchemas.cs
@@ -106,15 +106,35 @@ await VerifyOpenApiDocument(builder, document =>
                     Assert.Equal("name", property.Key);
                     Assert.Equal(JsonSchemaType.String | JsonSchemaType.Null, property.Value.Type);
                     Assert.Equal(5, property.Value.MinLength);
+                    Assert.Equal(10, property.Value.MaxLength);
                     Assert.Null(property.Value.Default);
                 },
                 property =>
+                {
+                    Assert.Equal("description", property.Key);
+                    Assert.Equal(JsonSchemaType.String | JsonSchemaType.Null, property.Value.Type);
+                    Assert.Equal(5, property.Value.MinLength);
+                    Assert.Equal(10, property.Value.MaxLength);
+                },
+                property =>
                 {
                     Assert.Equal("isPrivate", property.Key);
                     Assert.Equal(JsonSchemaType.Boolean, property.Value.Type);
                     Assert.True(property.Value.Default.GetValue<bool>());
+                },
+                property =>
+                {
+                    Assert.Equal("items", property.Key);
+                    Assert.Equal(JsonSchemaType.Array | JsonSchemaType.Null, property.Value.Type);
+                    Assert.Equal(10, property.Value.MaxItems);
+                },
+                property =>
+                {
+                    Assert.Equal("tags", property.Key);
+                    Assert.Equal(JsonSchemaType.Array | JsonSchemaType.Null, property.Value.Type);
+                    Assert.Equal(5, property.Value.MinItems);
+                    Assert.Equal(10, property.Value.MaxItems);
                 });
-
         });
     }
 
diff --git a/src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ResponseSchemas.cs b/src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ResponseSchemas.cs
@@ -130,12 +130,34 @@ await VerifyOpenApiDocument(builder, document =>
                     Assert.Equal("name", property.Key);
                     Assert.Equal(JsonSchemaType.String | JsonSchemaType.Null, property.Value.Type);
                     Assert.Equal(5, property.Value.MinLength);
+                    Assert.Equal(10, property.Value.MaxLength);
+                    Assert.Null(property.Value.Default);
+                },
+                property =>
+                {
+                    Assert.Equal("description", property.Key);
+                    Assert.Equal(JsonSchemaType.String | JsonSchemaType.Null, property.Value.Type);
+                    Assert.Equal(5, property.Value.MinLength);
+                    Assert.Equal(10, property.Value.MaxLength);
                 },
                 property =>
                 {
                     Assert.Equal("isPrivate", property.Key);
                     Assert.Equal(JsonSchemaType.Boolean, property.Value.Type);
                     Assert.True(property.Value.Default.GetValue<bool>());
+                },
+                property =>
+                {
+                    Assert.Equal("items", property.Key);
+                    Assert.Equal(JsonSchemaType.Array | JsonSchemaType.Null, property.Value.Type);
+                    Assert.Equal(10, property.Value.MaxItems);
+                },
+                property =>
+                {
+                    Assert.Equal("tags", property.Key);
+                    Assert.Equal(JsonSchemaType.Array | JsonSchemaType.Null, property.Value.Type);
+                    Assert.Equal(5, property.Value.MinItems);
+                    Assert.Equal(10, property.Value.MaxItems);
                 });
 
         });
diff --git a/src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Shared/SharedTypes.cs b/src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Shared/SharedTypes.cs
@@ -183,13 +183,29 @@ internal class ProjectBoard
     public int Id { get; set; }
 
     [MinLength(5)]
+    [MaxLength(10)]
     [DefaultValue(null)]
     [UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", Justification = "Used in tests.")]
     public string? Name { get; set; }
 
+    [Length(5, 10)]
+    [UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", Justification = "Used in tests.")]
+    public string? Description { get; set; }
+
     [DefaultValue(true)]
     public required bool IsPrivate { get; set; }
+
+    [MaxLength(10)]
+    [UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", Justification = "Used in tests.")]
+    public IList<ProjectBoardItem>? Items { get; set; }
+
+    [Length(5, 10)]
+    [UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", Justification = "Used in tests.")]
+    public IEnumerable<string>? Tags { get; set; }
 }
+
+internal sealed record ProjectBoardItem(string Name);
+
 #nullable restore
 
 internal class Account

Original file line number	Diff line number	Diff line change
`@@ -115,24 +115,20 @@ internal static void ApplyValidationAttributes(this JsonNode schema, IEnumerable`
`115`	`115`	`}`
`116`	`116`	`else if (attribute is MaxLengthAttribute maxLengthAttribute)`
`117`	`117`	`{`
`118`		`- var targetKey = schema[OpenApiSchemaKeywords.TypeKeyword]?.GetValue<string>() == "array" ? OpenApiSchemaKeywords.MaxItemsKeyword : OpenApiSchemaKeywords.MaxLengthKeyword;`
`119`		`- schema[targetKey] = maxLengthAttribute.Length;`
	`118`	`+ var isArray = MapJsonNodeToSchemaType(schema[OpenApiSchemaKeywords.TypeKeyword]) is { } schemaTypes && schemaTypes.HasFlag(JsonSchemaType.Array);`
	`119`	`+ var key = isArray ? OpenApiSchemaKeywords.MaxItemsKeyword : OpenApiSchemaKeywords.MaxLengthKeyword;`
	`120`	`+ schema[key] = maxLengthAttribute.Length;`
`120`	`121`	`}`
`121`	`122`	`else if (attribute is MinLengthAttribute minLengthAttribute)`
`122`	`123`	`{`
`123`		`- if (MapJsonNodeToSchemaType(schema[OpenApiSchemaKeywords.TypeKeyword]) is { } schemaTypes &&`
`124`		`- schemaTypes.HasFlag(JsonSchemaType.Array))`
`125`		`- {`
`126`		`- schema[OpenApiSchemaKeywords.MinItemsKeyword] = minLengthAttribute.Length;`
`127`		`- }`
`128`		`- else`
`129`		`- {`
`130`		`- schema[OpenApiSchemaKeywords.MinLengthKeyword] = minLengthAttribute.Length;`
`131`		`- }`
	`124`	`+ var isArray = MapJsonNodeToSchemaType(schema[OpenApiSchemaKeywords.TypeKeyword]) is { } schemaTypes && schemaTypes.HasFlag(JsonSchemaType.Array);`
	`125`	`+ var key = isArray ? OpenApiSchemaKeywords.MinItemsKeyword : OpenApiSchemaKeywords.MinLengthKeyword;`
	`126`	`+ schema[key] = minLengthAttribute.Length;`
`132`	`127`	`}`
`133`	`128`	`else if (attribute is LengthAttribute lengthAttribute)`
`134`	`129`	`{`
`135`		`- var targetKeySuffix = schema[OpenApiSchemaKeywords.TypeKeyword]?.GetValue<string>() == "array" ? "Items" : "Length";`
	`130`	`+ var isArray = MapJsonNodeToSchemaType(schema[OpenApiSchemaKeywords.TypeKeyword]) is { } schemaTypes && schemaTypes.HasFlag(JsonSchemaType.Array);`
	`131`	`+ var targetKeySuffix = isArray ? "Items" : "Length";`
`136`	`132`	`schema[$"min{targetKeySuffix}"] = lengthAttribute.MinimumLength;`
`137`	`133`	`schema[$"max{targetKeySuffix}"] = lengthAttribute.MaximumLength;`
`138`	`134`	`}`