Skip to content

Fix conflicting required+nullable schema when only NonNullableReferen… #3912

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 3 commits into from
Jun 16, 2026
Merged

Fix conflicting required+nullable schema when only NonNullableReferen… #3912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6254b15
Fix conflicting required+nullable schema when only NonNullableReferen…
KitKeen Apr 18, 2026
d03170f
Add test covering required+nullable preservation with NonNullableRefe…
KitKeen Apr 18, 2026
78f5b52
Assert schema.Required is not null before enumerating it
KitKeen May 20, 2026
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
2 changes: 1 addition & 1 deletion src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ private bool IsNullable(RequiredAttribute requiredAttribute, DataProperty dataPr
{
var nullable = dataProperty.IsNullable && requiredAttribute == null;

if (_generatorOptions.SupportNonNullableReferenceTypes)
if (_generatorOptions.SupportNonNullableReferenceTypes || _generatorOptions.NonNullableReferenceTypesAsRequired)
{
nullable &= !memberInfo.IsNonNullableReferenceType();
}
Expand Down
43 changes: 43 additions & 0 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 @@ -483,6 +483,32 @@ public void GenerateSchema_SetsRequiredAndNullable_IfPropertyHasRequiredKeywordA
AssertIsNullable(schema.Properties["RequiredNonNullableString"], false);
Assert.Contains("RequiredNonNullableString", schema.Required.ToArray());
}

[Fact]
public void GenerateSchema_NonNullableReferenceTypesAsRequired_PreservesNullable_IfPropertyHasRequiredKeywordAndIsNullable()
{
var schemaRepository = new SchemaRepository();

var referenceSchema = Subject(configureGenerator: (c) => c.NonNullableReferenceTypesAsRequired = true).GenerateSchema(typeof(TypeWithNullableReferenceTypes), schemaRepository);

var reference = Assert.IsType<OpenApiSchemaReference>(referenceSchema);

Assert.NotNull(reference);
Assert.NotNull(reference.Reference);
Assert.NotNull(reference.Reference.Id);

var schema = schemaRepository.Schemas[reference.Reference.Id];
Assert.NotNull(schema.Properties);
Assert.NotNull(schema.Required);

// required string? - must be present (required) AND may be null (nullable: true)
AssertIsNullable(schema.Properties["RequiredNullableString"]);
Assert.Contains("RequiredNullableString", schema.Required.ToArray());

// required string - must be present (required) AND must have a value (nullable: false)
AssertIsNullable(schema.Properties["RequiredNonNullableString"], false);
Assert.Contains("RequiredNonNullableString", schema.Required.ToArray());
}
#nullable disable

[Theory]
Expand Down Expand Up @@ -1126,6 +1152,23 @@ public void GenerateSchema_SupportsOption_SuppressImplicitRequiredAttributeForNo
Assert.True(propertyIsRequired);
}

[Theory]
[InlineData(typeof(TypeWithNullableContextAnnotated), nameof(TypeWithNullableContextAnnotated.SubTypeWithOneNonNullableContent), nameof(TypeWithNullableContextAnnotated.NonNullableString))]
[InlineData(typeof(TypeWithNullableContextNotAnnotated), nameof(TypeWithNullableContextNotAnnotated.SubTypeWithOneNonNullableContent), nameof(TypeWithNullableContextNotAnnotated.NonNullableString))]
public void GenerateSchema_NonNullableReferenceTypesAsRequired_DoesNotMarkPropertyAsNullable(
Type declaringType,
string subType,
string propertyName)
{
var subject = Subject(c => c.NonNullableReferenceTypesAsRequired = true);
var schemaRepository = new SchemaRepository();

subject.GenerateSchema(declaringType, schemaRepository);

var propertySchema = schemaRepository.Schemas[subType].Properties[propertyName];
AssertIsNullable(propertySchema, expected: false);
}

[Theory]
[InlineData(typeof(TypeWithNullableContextAnnotated), nameof(TypeWithNullableContextAnnotated.SubTypeWithNestedSubType.Nested), nameof(TypeWithNullableContextAnnotated.SubTypeWithNestedSubType.Nested.NullableString), true)]
[InlineData(typeof(TypeWithNullableContextAnnotated), nameof(TypeWithNullableContextAnnotated.SubTypeWithNestedSubType.Nested), nameof(TypeWithNullableContextAnnotated.SubTypeWithNestedSubType.Nested.NonNullableString), false)]
Expand Down
Loading