Skip to content

Fix InvalidCastException for nullable enum parameter default values i… #69918

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

Open
AnsElgyarDev wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −1
Open

Fix InvalidCastException for nullable enum parameter default values i… #69918

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
13 changes: 12 additions & 1 deletion src/OpenApi/src/Extensions/JsonNodeSchemaExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,8 +329,19 @@ internal static void ApplyParameterInfo(this JsonNode schema, ApiParameterDescri
{
if (parameterInfo.HasDefaultValue)
{
schema.ApplyDefaultValue(parameterInfo.DefaultValue, jsonTypeInfo);
var defaultValue = parameterInfo.DefaultValue;

// ParameterInfo.DefaultValue returns the underlying integral value for Nullable<TEnum> parameters,
// so convert it back to the enum type before serializing it.
if (defaultValue is not null
&& Nullable.GetUnderlyingType(parameterInfo.ParameterType) is { IsEnum: true } enumType)
{
defaultValue = Enum.ToObject(enumType, defaultValue);
}

schema.ApplyDefaultValue(defaultValue, jsonTypeInfo);
}

else if (parameterInfo.GetCustomAttributes<DefaultValueAttribute>().LastOrDefault() is { } defaultValueAttribute)
{
schema.ApplyDefaultValue(defaultValueAttribute.Value, jsonTypeInfo);
Expand Down
16 changes: 16 additions & 0 deletions ...Core.OpenApi.Tests/Services/OpenApiSchemaService/OpenApiSchemaService.ParameterSchemas.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,9 @@ await VerifyOpenApiDocument(builder, document =>
[(TaskStatus status = TaskStatus.Canceled) => { }, (JsonNode defaultValue) => Assert.Equal(6, defaultValue.GetValue<int>())],
// Default value for enums is serialized as string when a converter is registered.
[(Status status = Status.Pending) => { }, (JsonNode defaultValue) => Assert.Equal("Pending", defaultValue.GetValue<string>())],
[(Status? status = Status.Pending) => { }, (JsonNode defaultValue) => Assert.Equal("Pending", defaultValue.GetValue<string>())],
[(TaskStatus? status = TaskStatus.Canceled) => { }, (JsonNode defaultValue) => Assert.Equal(6, defaultValue.GetValue<int>())],
[(Status? status = null) => { }, (JsonNode defaultValue) => Assert.True(defaultValue is null)],
[([DefaultValue(2)] int id) => { }, (JsonNode defaultValue) => Assert.Equal(2, defaultValue.GetValue<int>())],
[([DefaultValue(3f)] float id) => { }, (JsonNode defaultValue) => Assert.Equal(3, defaultValue.GetValue<int>())],
[([DefaultValue("test")] string id) => { }, (JsonNode defaultValue) => Assert.Equal("test", defaultValue.GetValue<string>())],
Expand Down Expand Up @@ -198,6 +201,19 @@ await VerifyOpenApiDocument(builder, document =>
}
#nullable restore

[Fact]
public async Task GetOpenApiRequestBody_HandlesNullableEnumBodyParameterWithDefaultValue()
{
var builder = CreateBuilder();
builder.MapPost("/api/body", ([FromBody] Status? status = Status.Pending) => status);

await VerifyOpenApiDocument(builder, document =>
{
var op = document.Paths["/api/body"].Operations[HttpMethod.Post];
Assert.NotNull(op.RequestBody);
});
}

[Fact]
public async Task GetOpenApiParameters_HandlesEnumParameterWithoutConverter()
{
Expand Down
Loading