port domaindrivendev#2784 Handle Stream and PipeReader content types …

…correctly
Havunen · May 5, 2024 · 378e2ce · 378e2ce
1 parent 1247e24
commit 378e2ce
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
diff --git a/src/DotSwashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs b/src/DotSwashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs
@@ -235,6 +235,14 @@ private OpenApiSchema GeneratePolymorphicSchema(
             };
         }
 
+        private static readonly Type[] BinaryStringTypes = new[]
+        {
+            typeof(IFormFile),
+            typeof(FileResult),
+            typeof(System.IO.Stream),
+            typeof(System.IO.Pipelines.PipeReader),
+        };
+
         private OpenApiSchema GenerateConcreteSchema(
             DataContract dataContract,
             SchemaRepository schemaRepository,
@@ -246,7 +254,7 @@ bool isNullable
                 return customSchemaFactory();
             }
 
-            if (dataContract.UnderlyingType.IsAssignableToOneOf(typeof(IFormFile), typeof(FileResult)))
+            if (dataContract.UnderlyingType.IsAssignableToOneOf(BinaryStringTypes))
             {
                 return new OpenApiSchema { Type = "string", Format = "binary" };
             }

diff --git a/...tSwashbuckle.AspNetCore.Newtonsoft.Test/SchemaGenerator/NewtonsoftSchemaGeneratorTests.cs b/...tSwashbuckle.AspNetCore.Newtonsoft.Test/SchemaGenerator/NewtonsoftSchemaGeneratorTests.cs
@@ -21,6 +21,19 @@ namespace DotSwashbuckle.AspNetCore.Newtonsoft.Test
 {
     public class NewtonsoftSchemaGeneratorTests
     {
+        [Theory]
+        [InlineData(typeof(IFormFile))]
+        [InlineData(typeof(FileResult))]
+        [InlineData(typeof(System.IO.Stream))]
+        [InlineData(typeof(System.IO.Pipelines.PipeReader))]
+        public void GenerateSchema_GeneratesFileSchema_BinaryStringResultType(Type type)
+        {
+            var schema = Subject().GenerateSchema(type, new SchemaRepository());
+
+            Assert.Equal("string", schema.Type);
+            Assert.Equal("binary", schema.Format);
+        }
+
         [Fact]
         public void GenerateSchema_SetsUniqueItems_IfEnumerableTypeIsReadOnlySet()
         {

diff --git a/...shbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs b/...shbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs
@@ -23,6 +23,7 @@ namespace DotSwashbuckle.AspNetCore.SwaggerGen.Test
 {
     public class JsonSerializerSchemaGeneratorTests
     {
+
         [Fact]
         public void GenerateSchema_SetsUniqueItems_IfEnumerableTypeIsReadOnlySet()
         {
@@ -35,7 +36,9 @@ public void GenerateSchema_SetsUniqueItems_IfEnumerableTypeIsReadOnlySet()
         [Theory]
         [InlineData(typeof(IFormFile))]
         [InlineData(typeof(FileResult))]
-        public void GenerateSchema_GeneratesFileSchema_IfFormFileOrFileResultType(Type type)
+        [InlineData(typeof(System.IO.Stream))]
+        [InlineData(typeof(System.IO.Pipelines.PipeReader))]
+        public void GenerateSchema_GeneratesFileSchema_BinaryStringResultType(Type type)
         {
             var schema = Subject().GenerateSchema(type, new SchemaRepository());