Skip to content

Ensure the type keyword is included when generating schemas for nullable enums. #6440

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
May 14, 2025
Merged

Ensure the type keyword is included when generating schemas for nullable enums. #6440

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
6 changes: 6 additions & 0 deletions ...Libraries/Microsoft.Extensions.AI.Abstractions/Utilities/AIJsonUtilities.Schema.Create.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,12 @@ JsonNode TransformSchemaNode(JsonSchemaExporterContext schemaExporterContext, Js
objSchema.InsertAtStart(TypePropertyName, "string");
}

// Include the type keyword in nullable enum types
if (Nullable.GetUnderlyingType(ctx.TypeInfo.Type)?.IsEnum is true && objSchema.ContainsKey(EnumPropertyName) && !objSchema.ContainsKey(TypePropertyName))
{
objSchema.InsertAtStart(TypePropertyName, new JsonArray { (JsonNode)"string", (JsonNode)"null" });
}

// Filter potentially disallowed keywords.
foreach (string keyword in _schemaKeywordsDisallowedByAIVendors)
{
Expand Down
15 changes: 15 additions & 0 deletions test/Libraries/Microsoft.Extensions.AI.Abstractions.Tests/Utilities/AIJsonUtilitiesTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,20 @@ public static void CreateJsonSchema_AcceptsOptionsWithoutResolver()
Assert.Same(options.TypeInfoResolver, AIJsonUtilities.DefaultOptions.TypeInfoResolver);
}

[Fact]
public static void CreateJsonSchema_NullableEnum_IncludesTypeKeyword()
{
JsonElement expectedSchema = JsonDocument.Parse("""
{
"type": ["string", "null"],
"enum": ["A", "B", null]
}
""").RootElement;

JsonElement schema = AIJsonUtilities.CreateJsonSchema(typeof(MyEnumValue?), serializerOptions: JsonContext.Default.Options);
AssertDeepEquals(expectedSchema, schema);
}

[Fact]
public static void AddAIContentType_DerivedAIContent()
{
Expand Down Expand Up @@ -846,6 +860,7 @@ private class DerivedAIContent : AIContent
[JsonSerializable(typeof(DerivedAIContent))]
[JsonSerializable(typeof(MyPoco))]
[JsonSerializable(typeof(PocoWithTypesWithOpenAIUnsupportedKeywords))]
[JsonSerializable(typeof(MyEnumValue?))]
private partial class JsonContext : JsonSerializerContext;

private static bool DeepEquals(JsonElement element1, JsonElement element2)
Expand Down
Loading