Missing Encoding and RequiredProperties when IformFile withOpenApi (#2979)

jgarciadelanoceda · web-flow · commit 1d99754b0590 · 2024-07-10T23:36:12.000+01:00
diff --git a/src/Swashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SwaggerGenerator.cs b/src/Swashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SwaggerGenerator.cs
@@ -420,6 +420,7 @@ private OpenApiOperation GenerateOpenApiOperationFromMetadata(ApiDescription api
             {
                 foreach (var content in requestContentTypes)
                 {
+                    content.Encoding = new Dictionary<string, OpenApiEncoding>();
                     var requestParameters = apiDescription.ParameterDescriptions.Where(desc => desc.IsFromBody() || desc.IsFromForm());
                     var countOfParameters = requestParameters.Count();
                     if (countOfParameters > 0)
@@ -431,7 +432,7 @@ private OpenApiOperation GenerateOpenApiOperationFromMetadata(ApiDescription api
                                 requestParameter.ModelMetadata.ModelType,
                                 schemaRepository,
                                 requestParameter.PropertyInfo(),
-                                requestParameter.ParameterInfo()));
+                                requestParameter.ParameterInfo()), content);
                         }
                         else
                         {
@@ -442,25 +443,30 @@ private OpenApiOperation GenerateOpenApiOperationFromMetadata(ApiDescription api
                                     s.ModelMetadata.ModelType,
                                     schemaRepository,
                                     s.PropertyInfo(),
-                                    s.ParameterInfo())))
+                                    s.ParameterInfo()), content))
                                 .ToList()
                             };
                         }
                     }
 
-                    static OpenApiSchema GenerateSchemaIncludingFormFile(ApiParameterDescription apiParameterDescription, OpenApiSchema generatedSchema)
+                    static OpenApiSchema GenerateSchemaIncludingFormFile(ApiParameterDescription apiParameterDescription, OpenApiSchema generatedSchema, OpenApiMediaType mediaType)
                     {
-                        if (generatedSchema.Reference is null
-                            && ((generatedSchema.Type == "string" && generatedSchema.Format == "binary") || (generatedSchema.Type == "array" && generatedSchema.Items.Format == "binary")))
+                        if (generatedSchema.Reference is null && apiParameterDescription.IsFromForm())
                         {
-                            return new OpenApiSchema()
+                            mediaType.Encoding.Add(apiParameterDescription.Name, new OpenApiEncoding { Style = ParameterStyle.Form });
+                            if ((generatedSchema.Type == "string" && generatedSchema.Format == "binary")
+                                || (generatedSchema.Type == "array" && generatedSchema.Items.Type == "string" && generatedSchema.Items.Format == "binary"))
                             {
-                                Type = "object",
-                                Properties = new Dictionary<string, OpenApiSchema>()
+                                return new OpenApiSchema()
                                 {
-                                    [apiParameterDescription.Name] = generatedSchema
-                                }
-                            };
+                                    Type = "object",
+                                    Properties = new Dictionary<string, OpenApiSchema>()
+                                    {
+                                        [apiParameterDescription.Name] = generatedSchema
+                                    },
+                                    Required = apiParameterDescription.IsRequired ? new SortedSet<string>() { apiParameterDescription.Name } : null
+                                };
+                            }
                         }
                         return generatedSchema;
                     }
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/SwaggerVerifyIntegrationTest.SwaggerEndpoint_ReturnsValidSwaggerJson_For_WebApi_swaggerRequestUri=v1.verified.txt b/test/Swashbuckle.AspNetCore.IntegrationTests/SwaggerVerifyIntegrationTest.SwaggerEndpoint_ReturnsValidSwaggerJson_For_WebApi_swaggerRequestUri=v1.verified.txt
@@ -128,13 +128,21 @@
           "content": {
             "multipart/form-data": {
               "schema": {
+                "required": [
+                  "file"
+                ],
                 "type": "object",
                 "properties": {
                   "file": {
                     "type": "string",
                     "format": "binary"
                   }
                 }
+              },
+              "encoding": {
+                "file": {
+                  "style": "form"
+                }
               }
             }
           },
@@ -163,6 +171,9 @@
           "content": {
             "multipart/form-data": {
               "schema": {
+                "required": [
+                  "collection"
+                ],
                 "type": "object",
                 "properties": {
                   "collection": {
@@ -173,6 +184,11 @@
                     }
                   }
                 }
+              },
+              "encoding": {
+                "collection": {
+                  "style": "form"
+                }
               }
             }
           },
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/SwaggerVerifyIntegrationTest.TypesAreRenderedCorrectly.verified.txt b/test/Swashbuckle.AspNetCore.IntegrationTests/SwaggerVerifyIntegrationTest.TypesAreRenderedCorrectly.verified.txt
@@ -128,13 +128,21 @@
           "content": {
             "multipart/form-data": {
               "schema": {
+                "required": [
+                  "file"
+                ],
                 "type": "object",
                 "properties": {
                   "file": {
                     "type": "string",
                     "format": "binary"
                   }
                 }
+              },
+              "encoding": {
+                "file": {
+                  "style": "form"
+                }
               }
             }
           },
@@ -163,6 +171,9 @@
           "content": {
             "multipart/form-data": {
               "schema": {
+                "required": [
+                  "collection"
+                ],
                 "type": "object",
                 "properties": {
                   "collection": {
@@ -173,6 +184,11 @@
                     }
                   }
                 }
+              },
+              "encoding": {
+                "collection": {
+                  "style": "form"
+                }
               }
             }
           },
diff --git a/test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGenerator/SwaggerGeneratorTests.cs b/test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGenerator/SwaggerGeneratorTests.cs
@@ -2155,6 +2155,9 @@ public void GetSwagger_GenerateConsumesSchemas_ForProvidedOpenApiOperationWithIF
             Assert.NotNull(content.Value.Schema.Properties["param"]);
             Assert.Equal("string", content.Value.Schema.Properties["param"].Type);
             Assert.Equal("binary", content.Value.Schema.Properties["param"].Format);
+            Assert.NotNull(content.Value.Encoding);
+            Assert.NotNull(content.Value.Encoding["param"]);
+            Assert.Equal(ParameterStyle.Form, content.Value.Encoding["param"].Style);
         }
 
         [Fact]
@@ -2216,6 +2219,9 @@ public void GetSwagger_GenerateConsumesSchemas_ForProvidedOpenApiOperationWithIF
             Assert.NotNull(content.Value.Schema.Properties["param"].Items);
             Assert.Equal("string", content.Value.Schema.Properties["param"].Items.Type);
             Assert.Equal("binary", content.Value.Schema.Properties["param"].Items.Format);
+            Assert.NotNull(content.Value.Encoding);
+            Assert.NotNull(content.Value.Encoding["param"]);
+            Assert.Equal(ParameterStyle.Form, content.Value.Encoding["param"].Style);
         }
 
         private static SwaggerGenerator Subject(
diff --git a/test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGeneratorVerifyTests/SwaggerGeneratorVerifyTests.GetSwagger_GenerateConsumesSchemas_ForProvidedOpenApiOperationWithIFormFile.verified.txt b/test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGeneratorVerifyTests/SwaggerGeneratorVerifyTests.GetSwagger_GenerateConsumesSchemas_ForProvidedOpenApiOperationWithIFormFile.verified.txt
@@ -33,6 +33,11 @@
                   Nullable: false,
                   Deprecated: false,
                   UnresolvedReference: false
+                },
+                Encoding: {
+                  param: {
+                    Style: Form
+                  }
                 }
               }
             }
@@ -44,5 +49,5 @@
     }
   },
   Components: {},
-  HashCode: 3B411279DDA5AD71B248D9E65E29E2545971131294B8FB032C0EC91640277615B8D600D78530054A7DA3754611589518B2C9773BB48A813B9951B46DE633743A
+  HashCode: 7D034A2620C1D85B3AC60194DFA59693F727DE4704B2D02E124FDA37F843426C258EF2BEB84E6B8E8D315E23A4BCBE1F423B479E6CDF8AFFB8514D49B9A3CC9E
 }
diff --git a/test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGeneratorVerifyTests/SwaggerGeneratorVerifyTests.GetSwagger_GenerateConsumesSchemas_ForProvidedOpenApiOperationWithIFormFileCollection.verified.txt b/test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGeneratorVerifyTests/SwaggerGeneratorVerifyTests.GetSwagger_GenerateConsumesSchemas_ForProvidedOpenApiOperationWithIFormFileCollection.verified.txt
@@ -42,6 +42,11 @@
                   Nullable: false,
                   Deprecated: false,
                   UnresolvedReference: false
+                },
+                Encoding: {
+                  param: {
+                    Style: Form
+                  }
                 }
               }
             }
@@ -53,5 +58,5 @@
     }
   },
   Components: {},
-  HashCode: 64312D7E174EFA8B92E7869E39FD7367BB6A464F0C5E8A72D0B010AE96AAE157EE91BC02BEDFEC2B01CCC6BAA4E7FA79156782C09D435428AE8F732D3C9EB1B9
+  HashCode: 073D8B8E67D5100DD8AF06EC69A3C02B8DBF29E46621ED6EB590DEA519F2C8941398F6B95292D891CC4E18C2F4D5D38A8F904545CFFC219E4FF4613AD605E5A5
 }

Original file line number	Diff line number	Diff line change
`@@ -420,6 +420,7 @@ private OpenApiOperation GenerateOpenApiOperationFromMetadata(ApiDescription api`
`420`	`420`	`{`
`421`	`421`	`foreach (var content in requestContentTypes)`
`422`	`422`	`{`
	`423`	`+ content.Encoding = new Dictionary<string, OpenApiEncoding>();`
`423`	`424`	`var requestParameters = apiDescription.ParameterDescriptions.Where(desc => desc.IsFromBody() \|\| desc.IsFromForm());`
`424`	`425`	`var countOfParameters = requestParameters.Count();`
`425`	`426`	`if (countOfParameters > 0)`
`@@ -431,7 +432,7 @@ private OpenApiOperation GenerateOpenApiOperationFromMetadata(ApiDescription api`
`431`	`432`	`requestParameter.ModelMetadata.ModelType,`
`432`	`433`	`schemaRepository,`
`433`	`434`	`requestParameter.PropertyInfo(),`
`434`		`- requestParameter.ParameterInfo()));`
	`435`	`+ requestParameter.ParameterInfo()), content);`
`435`	`436`	`}`
`436`	`437`	`else`
`437`	`438`	`{`
`@@ -442,25 +443,30 @@ private OpenApiOperation GenerateOpenApiOperationFromMetadata(ApiDescription api`
`442`	`443`	`s.ModelMetadata.ModelType,`
`443`	`444`	`schemaRepository,`
`444`	`445`	`s.PropertyInfo(),`
`445`		`- s.ParameterInfo())))`
	`446`	`+ s.ParameterInfo()), content))`
`446`	`447`	`.ToList()`
`447`	`448`	`};`
`448`	`449`	`}`
`449`	`450`	`}`
`450`	`451`
`451`		`- static OpenApiSchema GenerateSchemaIncludingFormFile(ApiParameterDescription apiParameterDescription, OpenApiSchema generatedSchema)`
	`452`	`+ static OpenApiSchema GenerateSchemaIncludingFormFile(ApiParameterDescription apiParameterDescription, OpenApiSchema generatedSchema, OpenApiMediaType mediaType)`
`452`	`453`	`{`
`453`		`- if (generatedSchema.Reference is null`
`454`		`- && ((generatedSchema.Type == "string" && generatedSchema.Format == "binary") \|\| (generatedSchema.Type == "array" && generatedSchema.Items.Format == "binary")))`
	`454`	`+ if (generatedSchema.Reference is null && apiParameterDescription.IsFromForm())`
`455`	`455`	`{`
`456`		`- return new OpenApiSchema()`
	`456`	`+ mediaType.Encoding.Add(apiParameterDescription.Name, new OpenApiEncoding { Style = ParameterStyle.Form });`
	`457`	`+ if ((generatedSchema.Type == "string" && generatedSchema.Format == "binary")`
	`458`	`+ \|\| (generatedSchema.Type == "array" && generatedSchema.Items.Type == "string" && generatedSchema.Items.Format == "binary"))`
`457`	`459`	`{`
`458`		`- Type = "object",`
`459`		`- Properties = new Dictionary<string, OpenApiSchema>()`
	`460`	`+ return new OpenApiSchema()`
`460`	`461`	`{`
`461`		`- [apiParameterDescription.Name] = generatedSchema`
`462`		`- }`
`463`		`- };`
	`462`	`+ Type = "object",`
	`463`	`+ Properties = new Dictionary<string, OpenApiSchema>()`
	`464`	`+ {`
	`465`	`+ [apiParameterDescription.Name] = generatedSchema`
	`466`	`+ },`
	`467`	`+ Required = apiParameterDescription.IsRequired ? new SortedSet<string>() { apiParameterDescription.Name } : null`
	`468`	`+ };`
	`469`	`+ }`
`464`	`470`	`}`
`465`	`471`	`return generatedSchema;`
`466`	`472`	`}`
Original file line number	Diff line number	Diff line change
`@@ -128,13 +128,21 @@`
`128`	`128`	`"content": {`
`129`	`129`	`"multipart/form-data": {`
`130`	`130`	`"schema": {`
	`131`	`+ "required": [`
	`132`	`+ "file"`
	`133`	`+ ],`
`131`	`134`	`"type": "object",`
`132`	`135`	`"properties": {`
`133`	`136`	`"file": {`
`134`	`137`	`"type": "string",`
`135`	`138`	`"format": "binary"`
`136`	`139`	`}`
`137`	`140`	`}`
	`141`	`+ },`
	`142`	`+ "encoding": {`
	`143`	`+ "file": {`
	`144`	`+ "style": "form"`
	`145`	`+ }`
`138`	`146`	`}`
`139`	`147`	`}`
`140`	`148`	`},`
`@@ -163,6 +171,9 @@`
`163`	`171`	`"content": {`
`164`	`172`	`"multipart/form-data": {`
`165`	`173`	`"schema": {`
	`174`	`+ "required": [`
	`175`	`+ "collection"`
	`176`	`+ ],`
`166`	`177`	`"type": "object",`
`167`	`178`	`"properties": {`
`168`	`179`	`"collection": {`
`@@ -173,6 +184,11 @@`
`173`	`184`	`}`
`174`	`185`	`}`
`175`	`186`	`}`
	`187`	`+ },`
	`188`	`+ "encoding": {`
	`189`	`+ "collection": {`
	`190`	`+ "style": "form"`
	`191`	`+ }`
`176`	`192`	`}`
`177`	`193`	`}`
`178`	`194`	`},`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,11 @@`
`33`	`33`	`Nullable: false,`
`34`	`34`	`Deprecated: false,`
`35`	`35`	`UnresolvedReference: false`
	`36`	`+ },`
	`37`	`+ Encoding: {`
	`38`	`+ param: {`
	`39`	`+ Style: Form`
	`40`	`+ }`
`36`	`41`	`}`
`37`	`42`	`}`
`38`	`43`	`}`
`@@ -44,5 +49,5 @@`
`44`	`49`	`}`
`45`	`50`	`},`
`46`	`51`	`Components: {},`
`47`		`- HashCode: 3B411279DDA5AD71B248D9E65E29E2545971131294B8FB032C0EC91640277615B8D600D78530054A7DA3754611589518B2C9773BB48A813B9951B46DE633743A`
	`52`	`+ HashCode: 7D034A2620C1D85B3AC60194DFA59693F727DE4704B2D02E124FDA37F843426C258EF2BEB84E6B8E8D315E23A4BCBE1F423B479E6CDF8AFFB8514D49B9A3CC9E`
`48`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,11 @@`
`42`	`42`	`Nullable: false,`
`43`	`43`	`Deprecated: false,`
`44`	`44`	`UnresolvedReference: false`
	`45`	`+ },`
	`46`	`+ Encoding: {`
	`47`	`+ param: {`
	`48`	`+ Style: Form`
	`49`	`+ }`
`45`	`50`	`}`
`46`	`51`	`}`
`47`	`52`	`}`
`@@ -53,5 +58,5 @@`
`53`	`58`	`}`
`54`	`59`	`},`
`55`	`60`	`Components: {},`
`56`		`- HashCode: 64312D7E174EFA8B92E7869E39FD7367BB6A464F0C5E8A72D0B010AE96AAE157EE91BC02BEDFEC2B01CCC6BAA4E7FA79156782C09D435428AE8F732D3C9EB1B9`
	`61`	`+ HashCode: 073D8B8E67D5100DD8AF06EC69A3C02B8DBF29E46621ED6EB590DEA519F2C8941398F6B95292D891CC4E18C2F4D5D38A8F904545CFFC219E4FF4613AD605E5A5`
`57`	`62`	`}`