Unit test to show XmlCommentsSchemaFilter does not treat nullable str…

…ing properties with null values correctly
domaindrivendev · Jun 29, 2021 · b8dcad3 · b8dcad3
1 parent babad77
commit b8dcad3
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/test/Swashbuckle.AspNetCore.SwaggerGen.Test/Fixtures/XmlAnnotatedType.cs b/test/Swashbuckle.AspNetCore.SwaggerGen.Test/Fixtures/XmlAnnotatedType.cs
@@ -57,6 +57,12 @@ public class XmlAnnotatedType
         /// <example>d3966535-2637-48fa-b911-e3c27405ee09</example>
         public Guid GuidProperty { get; set; }
 
+        /// <summary>
+        /// Summary for Nullable StringProperty
+        /// </summary>
+        /// <example>null</example>
+        public string NullableStringProperty { get; set; }
+
         /// <summary>
         /// Summary for StringProperty
         /// </summary>

diff --git a/test/Swashbuckle.AspNetCore.SwaggerGen.Test/Swashbuckle.AspNetCore.SwaggerGen.Test.xml b/test/Swashbuckle.AspNetCore.SwaggerGen.Test/Swashbuckle.AspNetCore.SwaggerGen.Test.xml
diff --git a/test/Swashbuckle.AspNetCore.SwaggerGen.Test/XmlComments/XmlCommentsSchemaFilterTests.cs b/test/Swashbuckle.AspNetCore.SwaggerGen.Test/XmlComments/XmlCommentsSchemaFilterTests.cs
@@ -66,6 +66,7 @@ public void Apply_SetsDescription_FromPropertySummaryTag(
         [InlineData(typeof(XmlAnnotatedType), nameof(XmlAnnotatedType.GuidProperty), "string", "\"d3966535-2637-48fa-b911-e3c27405ee09\"")]
         [InlineData(typeof(XmlAnnotatedType), nameof(XmlAnnotatedType.StringProperty), "string", "\"Example for StringProperty\"")]
         [InlineData(typeof(XmlAnnotatedType), nameof(XmlAnnotatedType.ObjectProperty), "object", "{\n  \"prop1\": 1,\n  \"prop2\": \"foobar\"\n}")]
+        [InlineData(typeof(XmlAnnotatedType), nameof(XmlAnnotatedType.NullableStringProperty), "string", "null")]
         [UseInvariantCulture]
         public void Apply_SetsExample_FromPropertyExampleTag(
             Type declaringType,