Skip to content

Address PR #2645 review comments: improve type checking logic and use JsonNode.DeepEquals #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
desjoerd merged 4 commits into from
Dec 15, 2025
Merged

Address PR #2645 review comments: improve type checking logic and use JsonNode.DeepEquals #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f9984c9
Initial plan
Copilot Dec 15, 2025
cf00a1e
Fix PR review comments: replace Enum.IsDefined with power-of-2 check …
Copilot Dec 15, 2025
fadc853
Rewrite type checking logic to avoid cryptic binary operators
Copilot Dec 15, 2025
3f2402f
Use bitwise operator to remove Null flag from type comparison
Copilot Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 26 additions & 5 deletions src/Microsoft.OpenApi/Models/OpenApiSchema.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -877,20 +877,41 @@ private static (IList<IOpenApiSchema>? effective, JsonSchemaType? inferredType,

if (nonNullSchemas.Count > 0)
{
JsonSchemaType commonType = 0;
// Check if all schemas have the same type (excluding null)
JsonSchemaType? firstType = null;
bool allSameType = true;

foreach (var schema in nonNullSchemas)
{
commonType |= schema.Type.GetValueOrDefault() & ~JsonSchemaType.Null;
var schemaType = schema.Type;
if (schemaType.HasValue)
{
// Remove null from the type using bitwise operator
var typeWithoutNull = schemaType.Value & ~JsonSchemaType.Null;

if (typeWithoutNull != 0)
{
if (firstType == null)
{
firstType = typeWithoutNull;
}
else if (firstType != typeWithoutNull)
{
allSameType = false;
break;
}
}
}
}

if (System.Enum.IsDefined(commonType))
if (allSameType && firstType.HasValue)
{
// Single common type
return (nonNullSchemas, commonType, true);
// All schemas share the same type
return (nonNullSchemas, firstType.Value, true);
}
else
{
// Multiple different types
return (nonNullSchemas, null, true);
}

Expand Down
43 changes: 22 additions & 21 deletions test/Microsoft.OpenApi.Tests/Models/OpenApiSchemaTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -814,7 +814,7 @@ public async Task SerializeOneOfWithNullAsV3ShouldUseNullableAsync()
schema.SerializeAsV3(writer);
await writer.FlushAsync();

var v3Schema = outputStringWriter.GetStringBuilder().ToString().MakeLineBreaksEnvironmentNeutral();
var v3Schema = outputStringWriter.GetStringBuilder().ToString();

var expectedV3Schema =
"""
Expand All @@ -828,10 +828,10 @@ public async Task SerializeOneOfWithNullAsV3ShouldUseNullableAsync()
],
"nullable": true
}
""".MakeLineBreaksEnvironmentNeutral();
""";

// Assert
Assert.Equal(expectedV3Schema, v3Schema);
Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expectedV3Schema), JsonNode.Parse(v3Schema)));
}

[Fact]
Expand All @@ -855,7 +855,7 @@ public async Task SerializeOneOfWithNullAndMultipleSchemasAsV3ShouldMarkItAsNull
schema.SerializeAsV3(writer);
await writer.FlushAsync();

var v3Schema = outputStringWriter.GetStringBuilder().ToString().MakeLineBreaksEnvironmentNeutral();
var v3Schema = outputStringWriter.GetStringBuilder().ToString();

var expectedV3Schema =
"""
Expand All @@ -870,10 +870,10 @@ public async Task SerializeOneOfWithNullAndMultipleSchemasAsV3ShouldMarkItAsNull
],
"nullable": true
}
""".MakeLineBreaksEnvironmentNeutral();
""";

// Assert
Assert.Equal(expectedV3Schema, v3Schema);
Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expectedV3Schema), JsonNode.Parse(v3Schema)));
}

[Fact]
Expand Down Expand Up @@ -903,7 +903,7 @@ public async Task SerializeAnyOfWithNullAsV3ShouldUseNullableAsync()
schema.SerializeAsV3(writer);
await writer.FlushAsync();

var v3Schema = outputStringWriter.GetStringBuilder().ToString().MakeLineBreaksEnvironmentNeutral();
var v3Schema = outputStringWriter.GetStringBuilder().ToString();

var expectedV3Schema =
"""
Expand All @@ -921,8 +921,9 @@ public async Task SerializeAnyOfWithNullAsV3ShouldUseNullableAsync()
],
"nullable": true
}
""".MakeLineBreaksEnvironmentNeutral(); // Assert
Assert.Equal(expectedV3Schema, v3Schema);
""";
// Assert
Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expectedV3Schema), JsonNode.Parse(v3Schema)));
}

[Fact]
Expand All @@ -946,7 +947,7 @@ public async Task SerializeAnyOfWithNullAndMultipleSchemasAsV3ShouldApplyNullabl
schema.SerializeAsV3(writer);
await writer.FlushAsync();

var v3Schema = outputStringWriter.GetStringBuilder().ToString().MakeLineBreaksEnvironmentNeutral();
var v3Schema = outputStringWriter.GetStringBuilder().ToString();

var expectedV3Schema =
"""
Expand All @@ -962,10 +963,10 @@ public async Task SerializeAnyOfWithNullAndMultipleSchemasAsV3ShouldApplyNullabl
],
"nullable": true
}
""".MakeLineBreaksEnvironmentNeutral();
""";

// Assert
Assert.Equal(expectedV3Schema, v3Schema);
Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expectedV3Schema), JsonNode.Parse(v3Schema)));
}

[Fact]
Expand All @@ -987,17 +988,17 @@ public async Task SerializeOneOfWithOnlyNullAsV3ShouldJustBeNullableAsync()
schema.SerializeAsV3(writer);
await writer.FlushAsync();

var v3Schema = outputStringWriter.GetStringBuilder().ToString().MakeLineBreaksEnvironmentNeutral();
var v3Schema = outputStringWriter.GetStringBuilder().ToString();

var expectedV3Schema =
"""
{
"nullable": true
}
""".MakeLineBreaksEnvironmentNeutral();
""";

// Assert
Assert.Equal(expectedV3Schema, v3Schema);
Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expectedV3Schema), JsonNode.Parse(v3Schema)));
}

[Fact]
Expand All @@ -1020,7 +1021,7 @@ public async Task SerializeOneOfWithNullAsV31ShouldNotChangeAsync()
schema.SerializeAsV31(writer);
await writer.FlushAsync();

var v31Schema = outputStringWriter.GetStringBuilder().ToString().MakeLineBreaksEnvironmentNeutral();
var v31Schema = outputStringWriter.GetStringBuilder().ToString();

var expectedV31Schema =
"""
Expand All @@ -1034,10 +1035,10 @@ public async Task SerializeOneOfWithNullAsV31ShouldNotChangeAsync()
}
]
}
""".MakeLineBreaksEnvironmentNeutral();
""";

// Assert
Assert.Equal(expectedV31Schema, v31Schema);
Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expectedV31Schema), JsonNode.Parse(v31Schema)));
}

[Fact]
Expand Down Expand Up @@ -1084,7 +1085,7 @@ public async Task SerializeOneOfWithNullAndRefAsV3ShouldUseNullableAsync()
schema.SerializeAsV3(writer);
await writer.FlushAsync();

var v3Schema = outputStringWriter.GetStringBuilder().ToString().MakeLineBreaksEnvironmentNeutral();
var v3Schema = outputStringWriter.GetStringBuilder().ToString();

var expectedV3Schema =
"""
Expand All @@ -1097,10 +1098,10 @@ public async Task SerializeOneOfWithNullAndRefAsV3ShouldUseNullableAsync()
],
"nullable": true
}
""".MakeLineBreaksEnvironmentNeutral();
""";

// Assert
Assert.Equal(expectedV3Schema, v3Schema);
Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expectedV3Schema), JsonNode.Parse(v3Schema)));
}

internal class SchemaVisitor : OpenApiVisitorBase
Expand Down