fix: do not write null for types on parameters in v2

microsoft · Feb 5, 2025 · 4aef7b7 · 4aef7b7
1 parent 3c5f8ab
commit 4aef7b7
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 1 deletion.
diff --git a/src/Microsoft.OpenApi/Models/OpenApiSchema.cs b/src/Microsoft.OpenApi/Models/OpenApiSchema.cs
@@ -413,7 +413,7 @@ internal void WriteJsonSchemaKeywords(IOpenApiWriter writer)
         internal void WriteAsItemsProperties(IOpenApiWriter writer)
         {
             // type
-            writer.WriteProperty(OpenApiConstants.Type, Type.ToIdentifier());
+            writer.WriteProperty(OpenApiConstants.Type, (Type & ~JsonSchemaType.Null).ToIdentifier());
 
             // format
             WriteFormatProperty(writer);

diff --git a/test/Microsoft.OpenApi.Tests/Models/OpenApiSchemaTests.cs b/test/Microsoft.OpenApi.Tests/Models/OpenApiSchemaTests.cs
@@ -624,6 +624,36 @@ public async Task SerializeSchemaWithUnrecognizedPropertiesWorks()
             Assert.Equal(expected.MakeLineBreaksEnvironmentNeutral(), actual.MakeLineBreaksEnvironmentNeutral());
         }
 
+        [Fact]
+        public async Task WriteAsItemsPropertiesDoesNotWriteNull()
+        {
+            // Arrange
+            var schema = new OpenApiSchema
+            {
+                Type = JsonSchemaType.Number | JsonSchemaType.Null
+            };
+
+            var outputStringWriter = new StringWriter(CultureInfo.InvariantCulture);
+            var writer = new OpenApiJsonWriter(outputStringWriter, new() { Terse = false });
+            writer.WriteStartObject();
+
+            // Act
+            schema.WriteAsItemsProperties(writer);
+            writer.WriteEndObject();
+            await writer.FlushAsync();
+
+            // Assert
+            var actual = outputStringWriter.GetStringBuilder().ToString();
+            var expected =
+            """
+            {
+                "type": "number"
+            }
+            """;
+            Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expected), JsonNode.Parse(actual)));
+        }
+
+
         internal class SchemaVisitor : OpenApiVisitorBase
         {
             public List<string> Titles = new();