allow schema to be null in example creation

domaindrivendev · Apr 15, 2024 · 3ca86f8 · 3ca86f8
1 parent fa399af
commit 3ca86f8
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsExampleHelper.cs b/src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsExampleHelper.cs
@@ -12,7 +12,7 @@ public static class XmlCommentsExampleHelper
             string exampleString)
         {
             var isStringType =
-                (schema.ResolveType(schemaRepository) == "string") &&
+                (schema?.ResolveType(schemaRepository) == "string") &&
                 !exampleString.Equals("null");
 
             var exampleAsJson = isStringType

diff --git a/src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsParameterFilter.cs b/src/Swashbuckle.AspNetCore.SwaggerGen/XmlComments/XmlCommentsParameterFilter.cs
@@ -67,7 +67,7 @@ private void ApplyParamTags(OpenApiParameter parameter, ParameterFilterContext c
                 var example = paramNode.GetAttribute("example", "");
                 if (string.IsNullOrEmpty(example)) return;
 
-                parameter.Example = XmlCommentsExampleHelper.Create(context.SchemaRepository, parameter.Schema, example.ToString());
+                parameter.Example = XmlCommentsExampleHelper.Create(context.SchemaRepository, parameter.Schema, example);
             }
         }
     }

diff --git a/test/Swashbuckle.AspNetCore.SwaggerGen.Test/XmlComments/XmlCommentsExampleHelperTests.cs b/test/Swashbuckle.AspNetCore.SwaggerGen.Test/XmlComments/XmlCommentsExampleHelperTests.cs
@@ -50,5 +50,15 @@ public void Create_ReturnsNull_When_TypeString_and_ValueNull()
 
             Assert.Equal(AnyType.Null, ((OpenApiNull)example).AnyType);
         }
+
+        [Fact]
+        public void Create_AllowsSchemaToBeNull()
+        {
+            OpenApiSchema schema = null;
+
+            IOpenApiAny example = XmlCommentsExampleHelper.Create(schemaRepository, schema, "[]");
+
+            Assert.Empty((OpenApiArray)example);
+        }
     }
 }