Revert nullable changes for allOf

martincostello · martincostello · commit 243201c1b4fa · 2025-11-30T19:55:25.000Z
Reverts 141a54c.
diff --git a/src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs b/src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs
@@ -49,12 +49,9 @@ private IOpenApiSchema GenerateSchemaForMember(
             ? GeneratePolymorphicSchema(schemaRepository, knownTypesDataContracts)
             : GenerateConcreteSchema(dataContract, schemaRepository);
 
-        bool usingAllOf = false;
-
         if (_generatorOptions.UseAllOfToExtendReferenceSchemas && schema is OpenApiSchemaReference reference)
         {
             schema = new OpenApiSchema() { AllOf = [reference] };
-            usingAllOf = true;
         }
 
         if (schema is OpenApiSchema concrete)
@@ -66,12 +63,12 @@ private IOpenApiSchema GenerateSchemaForMember(
             {
                 var requiredAttribute = customAttributes.OfType<RequiredAttribute>().FirstOrDefault();
 
-                // "nullable" cannot be used without "type"
-                if (!usingAllOf)
-                {
-                    var nullable = IsNullable(requiredAttribute, dataProperty, memberInfo);
-                    SetNullable(concrete, nullable);
-                }
+                // "nullable" cannot be used without "type", however this was added in a patch
+                // change to OpenAPI 3.0 which would cause compatibility issues for existing users
+                // if it were changed, so this is intentionally not compliant with the OpenAPI specification.
+                // See https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/3683#issuecomment-3593065197.
+                var nullable = IsNullable(requiredAttribute, dataProperty, memberInfo);
+                SetNullable(concrete, nullable);
 
                 concrete.ReadOnly = dataProperty.IsReadOnly;
                 concrete.WriteOnly = dataProperty.IsWriteOnly;
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/KiotaClientTests.cs b/test/Swashbuckle.AspNetCore.IntegrationTests/KiotaClientTests.cs
@@ -21,7 +21,7 @@ await WithTodoAppClientAsync(async (client) =>
             // Act - Get all the items
             var items = await client.Api.Items.GetAsync(cancellationToken: cancellationToken);
 
-            // Assert - There should be no items
+            // Assert
             Assert.NotNull(items);
             Assert.NotNull(items.Items);
 
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/KiotaTodoClient/kiota-lock.json b/test/Swashbuckle.AspNetCore.IntegrationTests/KiotaTodoClient/kiota-lock.json
@@ -1,5 +1,5 @@
 {
-  "descriptionHash": "6220470D2DBDA8D33A3A26AE0D99FD08E8CA025558CE7AF3EFA771BEE7F540049DFB9E14E28367BD30CC488F5A918670E40CF226C0C825CC163EDBFFA1CCE766",
+  "descriptionHash": "DF0ACFCDC1F5CFB97A2DFB0E7A7BB004B889E5742C1925E797BC2A6B816489D5C9A4A8413CB3795FA45E7589D0E04D80856F3558CD656308C19DBDA9446A0712",
   "descriptionLocation": "../snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=TodoApp.Program_swaggerRequestUri=v1.DotNet10_0.verified.txt",
   "lockFileVersion": "1.0.0",
   "kiotaVersion": "1.29.0",
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/NSwagClientTests.cs b/test/Swashbuckle.AspNetCore.IntegrationTests/NSwagClientTests.cs
@@ -46,7 +46,7 @@ await WithTodoAppClientAsync(async (client) =>
             Assert.Null(item.CompletedAt);
             Assert.NotEqual(default, item.CreatedAt);
             Assert.Equal(item.CreatedAt, item.LastUpdated);
-            Assert.Equal(TodoPriority.Normal, item.Priority);
+            Assert.Null(item.Priority);
             Assert.Equal(text, item.Text);
 
             // Act - Update the item to be high priority
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/NSwagTodoClient/NSwagTodoClient.cs b/test/Swashbuckle.AspNetCore.IntegrationTests/NSwagTodoClient/NSwagTodoClient.cs
@@ -1113,9 +1113,9 @@ public partial class TodoItemModel
         /// <summary>
         /// Gets or sets the optional priority of the Todo item.
         /// </summary>
-        [Newtonsoft.Json.JsonProperty("priority", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
+        [Newtonsoft.Json.JsonProperty("priority", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
         [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
-        public TodoPriority Priority { get; set; }
+        public TodoPriority? Priority { get; set; }
 
     }
 
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/CodeGenerationTests.VerifyNSwagTodoAppClient/NSwagTodoClient.verified.cs b/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/CodeGenerationTests.VerifyNSwagTodoAppClient/NSwagTodoClient.verified.cs
@@ -1113,9 +1113,9 @@ public partial class TodoItemModel
         /// <summary>
         /// Gets or sets the optional priority of the Todo item.
         /// </summary>
-        [Newtonsoft.Json.JsonProperty("priority", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
+        [Newtonsoft.Json.JsonProperty("priority", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
         [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
-        public TodoPriority Priority { get; set; }
+        public TodoPriority? Priority { get; set; }
 
     }
 
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/GeneratesValidClient_a4dcbaf37de46e5e/NSwagOpenApiClient.verified.cs b/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/GeneratesValidClient_a4dcbaf37de46e5e/NSwagOpenApiClient.verified.cs
@@ -1113,9 +1113,9 @@ public partial class TodoItemModel
         /// <summary>
         /// Gets or sets the optional priority of the Todo item.
         /// </summary>
-        [Newtonsoft.Json.JsonProperty("priority", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
+        [Newtonsoft.Json.JsonProperty("priority", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
         [Newtonsoft.Json.JsonConverter(typeof(Newtonsoft.Json.Converters.StringEnumConverter))]
-        public TodoPriority Priority { get; set; }
+        public TodoPriority? Priority { get; set; }
 
     }
 
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=MinimalAppWithNullableEnums.Program_swaggerRequestUri=v1.DotNet10_0.verified.txt b/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=MinimalAppWithNullableEnums.Program_swaggerRequestUri=v1.DotNet10_0.verified.txt
@@ -48,6 +48,7 @@
         "type": "object",
         "properties": {
           "child": {
+            "type": "null",
             "allOf": [
               {
                 "$ref": "#/components/schemas/Child"
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=MinimalAppWithNullableEnums.Program_swaggerRequestUri=v1.DotNet8_0.verified.txt b/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=MinimalAppWithNullableEnums.Program_swaggerRequestUri=v1.DotNet8_0.verified.txt
@@ -48,6 +48,7 @@
         "type": "object",
         "properties": {
           "child": {
+            "type": "null",
             "allOf": [
               {
                 "$ref": "#/components/schemas/Child"
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=MinimalAppWithNullableEnums.Program_swaggerRequestUri=v1.DotNet9_0.verified.txt b/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=MinimalAppWithNullableEnums.Program_swaggerRequestUri=v1.DotNet9_0.verified.txt
@@ -48,6 +48,7 @@
         "type": "object",
         "properties": {
           "child": {
+            "type": "null",
             "allOf": [
               {
                 "$ref": "#/components/schemas/Child"
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=TodoApp.Program_swaggerRequestUri=v1.DotNet10_0.verified.txt b/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=TodoApp.Program_swaggerRequestUri=v1.DotNet10_0.verified.txt
@@ -420,7 +420,8 @@
                 "$ref": "#/components/schemas/TodoPriority"
               }
             ],
-            "description": "Gets or sets the optional priority of the Todo item."
+            "description": "Gets or sets the optional priority of the Todo item.",
+            "nullable": true
           }
         },
         "additionalProperties": false,
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=TodoApp.Program_swaggerRequestUri=v1.DotNet8_0.verified.txt b/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=TodoApp.Program_swaggerRequestUri=v1.DotNet8_0.verified.txt
@@ -418,7 +418,8 @@
                 "$ref": "#/components/schemas/TodoPriority"
               }
             ],
-            "description": "Gets or sets the optional priority of the Todo item."
+            "description": "Gets or sets the optional priority of the Todo item.",
+            "nullable": true
           }
         },
         "additionalProperties": false,
diff --git a/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=TodoApp.Program_swaggerRequestUri=v1.DotNet9_0.verified.txt b/test/Swashbuckle.AspNetCore.IntegrationTests/snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=TodoApp.Program_swaggerRequestUri=v1.DotNet9_0.verified.txt
@@ -418,7 +418,8 @@
                 "$ref": "#/components/schemas/TodoPriority"
               }
             ],
-            "description": "Gets or sets the optional priority of the Todo item."
+            "description": "Gets or sets the optional priority of the Todo item.",
+            "nullable": true
           }
         },
         "additionalProperties": false,

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "descriptionHash": "6220470D2DBDA8D33A3A26AE0D99FD08E8CA025558CE7AF3EFA771BEE7F540049DFB9E14E28367BD30CC488F5A918670E40CF226C0C825CC163EDBFFA1CCE766",`
	`2`	`+ "descriptionHash": "DF0ACFCDC1F5CFB97A2DFB0E7A7BB004B889E5742C1925E797BC2A6B816489D5C9A4A8413CB3795FA45E7589D0E04D80856F3558CD656308C19DBDA9446A0712",`
`3`	`3`	`"descriptionLocation": "../snapshots/VerifyTests.Swagger_IsValidJson_No_Startup_entryPointType=TodoApp.Program_swaggerRequestUri=v1.DotNet10_0.verified.txt",`
`4`	`4`	`"lockFileVersion": "1.0.0",`
`5`	`5`	`"kiotaVersion": "1.29.0",`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@`
`48`	`48`	`"type": "object",`
`49`	`49`	`"properties": {`
`50`	`50`	`"child": {`
	`51`	`+ "type": "null",`
`51`	`52`	`"allOf": [`
`52`	`53`	`{`
`53`	`54`	`"$ref": "#/components/schemas/Child"`