Fix to make required and nullable properties nullable in schema (#2879)

Fix to make required and nullable properties nullable in schema. - Added test for type with required nullable properties.
domaindrivendev · May 14, 2024 · a29ba36 · a29ba36
1 parent 8908e1e
commit a29ba36
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 20 deletions.
diff --git a/src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs b/src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs
@@ -68,24 +68,13 @@ public SchemaGenerator(SchemaGeneratorOptions generatorOptions, ISerializerDataC
                 {
                     var requiredAttribute = customAttributes.OfType<RequiredAttribute>().FirstOrDefault();
 
-                    schema.ReadOnly = dataProperty.IsReadOnly;
-                    schema.WriteOnly = dataProperty.IsWriteOnly;
-
-#if NET7_0_OR_GREATER
-                    var hasRequiredMemberAttribute = customAttributes.OfType<System.Runtime.CompilerServices.RequiredMemberAttribute>().Any();
-
                     schema.Nullable = _generatorOptions.SupportNonNullableReferenceTypes
-                        ? dataProperty.IsNullable && requiredAttribute == null && !hasRequiredMemberAttribute && !memberInfo.IsNonNullableReferenceType()
-                        : dataProperty.IsNullable && requiredAttribute == null && !hasRequiredMemberAttribute;
-
-                    schema.MinLength = modelType == typeof(string) && (hasRequiredMemberAttribute || requiredAttribute is { AllowEmptyStrings: false }) ? 1 : null;
-#else
-                    schema.Nullable = _generatorOptions.SupportNonNullableReferenceTypes
-                        ? dataProperty.IsNullable && requiredAttribute==null && !memberInfo.IsNonNullableReferenceType()
-                        : dataProperty.IsNullable && requiredAttribute==null;
+                        ? dataProperty.IsNullable && requiredAttribute == null && !memberInfo.IsNonNullableReferenceType()
+                        : dataProperty.IsNullable && requiredAttribute == null;
 
+                    schema.ReadOnly = dataProperty.IsReadOnly;
+                    schema.WriteOnly = dataProperty.IsWriteOnly;
                     schema.MinLength = modelType == typeof(string) && requiredAttribute is { AllowEmptyStrings: false } ? 1 : null;
-#endif
                 }
 
                 var defaultValueAttribute = customAttributes.OfType<DefaultValueAttribute>().FirstOrDefault();

diff --git a/...shbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs b/...shbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs
@@ -367,9 +367,10 @@ public void GenerateSchema_SetsReadOnlyAndWriteOnlyFlags_IfPropertyIsRestricted(
         }
 
 #if NET7_0_OR_GREATER
-        public class TypeWithRequiredProperty
+        public class TypeWithRequiredProperties
         {
-            public required string RequiredProperty { get; set; }
+            public required string RequiredString { get; set; }
+            public required int RequiredInt { get; set; }
         }
 
         public class TypeWithRequiredPropertyAndValidationAttribute
@@ -383,10 +384,13 @@ public void GenerateSchema_SetsRequired_IfPropertyHasRequiredKeyword()
         {
             var schemaRepository = new SchemaRepository();
 
-            var referenceSchema = Subject().GenerateSchema(typeof(TypeWithRequiredProperty), schemaRepository);
+            var referenceSchema = Subject().GenerateSchema(typeof(TypeWithRequiredProperties), schemaRepository);
 
             var schema = schemaRepository.Schemas[referenceSchema.Reference.Id];
-            Assert.Equal(new[] { "RequiredProperty" }, schema.Required.ToArray());
+            Assert.True(schema.Properties["RequiredString"].Nullable);
+            Assert.Contains("RequiredString", schema.Required.ToArray());
+            Assert.False(schema.Properties["RequiredInt"].Nullable);
+            Assert.Contains("RequiredInt", schema.Required.ToArray());
         }
 
         [Fact]
@@ -398,9 +402,31 @@ public void GenerateSchema_SetsRequired_IfPropertyHasRequiredKeywordAndValidatio
 
             var schema = schemaRepository.Schemas[referenceSchema.Reference.Id];
             Assert.Equal(1, schema.Properties["RequiredProperty"].MinLength);
-            Assert.False(schema.Properties["RequiredProperty"].Nullable);
+            Assert.True(schema.Properties["RequiredProperty"].Nullable);
             Assert.Equal(new[] { "RequiredProperty" }, schema.Required.ToArray());
         }
+
+#nullable enable
+        public class TypeWithNullableReferenceTypes
+        {
+            public required string? RequiredNullableString { get; set; }
+            public required string RequiredNonNullableString { get; set; }
+        }
+
+        [Fact]
+        public void GenerateSchema_SetsRequiredAndNullable_IfPropertyHasRequiredKeywordAndIsNullable()
+        {
+            var schemaRepository = new SchemaRepository();
+
+            var referenceSchema = Subject(configureGenerator: (c) => c.SupportNonNullableReferenceTypes = true).GenerateSchema(typeof(TypeWithNullableReferenceTypes), schemaRepository);
+
+            var schema = schemaRepository.Schemas[referenceSchema.Reference.Id];
+            Assert.True(schema.Properties["RequiredNullableString"].Nullable);
+            Assert.Contains("RequiredNullableString", schema.Required.ToArray());
+            Assert.False(schema.Properties["RequiredNonNullableString"].Nullable);
+            Assert.Contains("RequiredNonNullableString", schema.Required.ToArray());
+        }
+#nullable disable
 #endif
 
         [Theory]