Skip to content

Update to fix Lists/Arrays of nullables not getting marked as nullable #3364

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
martincostello merged 4 commits into from
Apr 14, 2025
+18 −8
Merged

Update to fix Lists/Arrays of nullables not getting marked as nullable #3364

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
3da6822
Update to fix Lists/Arrays of nullables not getting marked as nullable
wolf7250 Apr 11, 2025
7027900
Updated unit test to cover whether items in a array are correctly mar…
wolf7250 Apr 11, 2025
3327490
Update src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGe…
Scarecrow7250 Apr 13, 2025
36f4b93
Added some more test cases to unit tests
wolf7250 Apr 14, 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
4 changes: 4 additions & 0 deletions src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,10 @@ private OpenApiSchema GenerateSchemaForType(Type modelType, SchemaRepository sch
if (schema.Reference == null)
{
ApplyFilters(schema, modelType, schemaRepository);
if (Nullable.GetUnderlyingType(modelType) != null)
{
schema.Nullable = true;
}
}

return schema;
Expand Down
22 changes: 14 additions & 8 deletions ...shbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,28 +161,34 @@ public void GenerateSchema_GeneratesReferencedDictionarySchema_IfDictionaryTypeI
Assert.Equal(schema.AdditionalProperties.Reference.Id, referenceSchema.Reference.Id); // ref to self
}

public static TheoryData<Type, JsonSchemaType, string> EnumerableTypeData => new()
{
{ typeof(int[]), JsonSchemaTypes.Integer, "int32" },
{ typeof(IEnumerable<string>), JsonSchemaTypes.String, null },
{ typeof(DateTime?[]), JsonSchemaTypes.String, "date-time" },
{ typeof(int[][]), JsonSchemaTypes.Array, null },
{ typeof(IList), null, null },
public static TheoryData<Type, JsonSchemaType, string, bool> EnumerableTypeData => new()
Comment thread
martincostello marked this conversation as resolved.
{
{ typeof(int[]), JsonSchemaTypes.Integer, "int32", false },
{ typeof(int?[]), JsonSchemaTypes.Integer, "int32", true },
{ typeof(double[]), JsonSchemaTypes.Number, "double", false },
{ typeof(double?[]), JsonSchemaTypes.Number, "double", true },
{ typeof(DateTime[]), JsonSchemaTypes.String, "date-time", false },
{ typeof(DateTime?[]), JsonSchemaTypes.String, "date-time", true },
{ typeof(IEnumerable<string>), JsonSchemaTypes.String, null, false },
{ typeof(int[][]), JsonSchemaTypes.Array, null, false },
{ typeof(IList), null, null, false },
};

[Theory]
[MemberData(nameof(EnumerableTypeData))]
public void GenerateSchema_GeneratesArraySchema_IfEnumerableType(
Type type,
JsonSchemaType expectedItemsType,
string expectedItemsFormat)
string expectedItemsFormat,
bool expectedItemsNullable)
{
var schema = Subject().GenerateSchema(type, new SchemaRepository());

Assert.Equal(JsonSchemaTypes.Array, schema.Type);
Assert.NotNull(schema.Items);
Assert.Equal(expectedItemsType, schema.Items.Type);
Assert.Equal(expectedItemsFormat, schema.Items.Format);
Assert.Equal(expectedItemsNullable, schema.Items.Nullable);
}

[Theory]
Expand Down
⚡