Skip to content

fix: a bug where null sentinel value would appear in YAML documents #2576

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
merged 1 commit into from
Nov 6, 2025
Merged

fix: a bug where null sentinel value would appear in YAML documents #2576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
fix: a bug where null sentinel value would appear in YAML documents 
Signed-off-by: Vincent Biret <[email protected]>
  • Loading branch information
@baywet
baywet committed Nov 6, 2025
commit 15618e1f6a79874ae61dc31e3bcd5e1f3177d7ff
4 changes: 4 additions & 0 deletions src/Microsoft.OpenApi.YamlReader/YamlConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ public static YamlNode ToYamlNode(this JsonNode json)
{
JsonObject obj => obj.ToYamlMapping(),
JsonArray arr => arr.ToYamlSequence(),
JsonValue nullVal when JsonNullSentinel.IsJsonNullSentinel(nullVal) => new YamlScalarNode("null")
{
Style = ScalarStyle.Plain
},
JsonValue val => val.ToYamlScalar(),
_ => throw new NotSupportedException("This isn't a supported JsonNode")
};
Expand Down
11 changes: 10 additions & 1 deletion test/Microsoft.OpenApi.Readers.Tests/YamlConverterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
using Microsoft.OpenApi.YamlReader;
using SharpYaml;
using SharpYaml.Serialization;
using System;
using System.IO;
using System.Text.Json.Nodes;
using Xunit;
Expand Down Expand Up @@ -302,10 +303,18 @@ from openai import OpenAI
var jsonNode = ConvertYamlStringToJsonNode(yamlInput);
var convertedBack = jsonNode.ToYamlNode();
var convertedBackOutput = ConvertYamlNodeToString(convertedBack);

// Then
Assert.Equal(yamlInput.MakeLineBreaksEnvironmentNeutral(), convertedBackOutput.MakeLineBreaksEnvironmentNeutral());
}
[Fact]
public void ItDoesNotSerializeTheSentinelValue()
{
var yamlValue = JsonNullSentinel.JsonNull.ToYamlNode();

var scalarNode = Assert.IsType<YamlScalarNode>(yamlValue);
Assert.Equal("null", scalarNode.Value, StringComparer.OrdinalIgnoreCase);
}

private static JsonNode ConvertYamlStringToJsonNode(string yamlInput)
{
Expand Down
Loading