Merge branch 'main' into dev/ygerges/multiple-types-3

Author: Youssef1313

.github/workflows/codeql-analysis.yml

@@ -34,7 +34,7 @@ jobs:
 
       - name: Initialize CodeQL
         id: init_codeql
-        uses: github/codeql-action/init@v4.37.2
+        uses: github/codeql-action/init@v4.37.3
         with:
           queries: security-and-quality
 
@@ -54,6 +54,6 @@ jobs:
 
       - name: Perform CodeQL Analysis
         id: analyze_codeql
-        uses: github/codeql-action/analyze@v4.37.2
+        uses: github/codeql-action/analyze@v4.37.3
 
 # Built with ❤ by [Pipeline Foundation](https://pipeline.foundation)

.github/workflows/sonarcloud.yml

@@ -35,7 +35,7 @@ jobs:
     runs-on: windows-latest
     steps:
       - name: Set up JDK 17
-        uses: actions/setup-java@v5
+        uses: actions/setup-java@v5.6.0
         with:
           distribution: 'adopt'
           java-version: 17

src/Microsoft.OpenApi/Models/OpenApiSchema.cs

@@ -550,7 +550,7 @@ private void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version
             }
 
             // type
-            var serializedTypeProperty = TrySerializeTypePropertyForVersion3AndLater(writer, version, callback);
+            SerializeTypePropertyForVersion3AndLater(writer, version, callback);
 
             // allOf
             writer.WriteOptionalCollection(OpenApiConstants.AllOf, AllOf, callback);
@@ -595,13 +595,13 @@ private void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version
             writer.WriteOptionalObject(OpenApiConstants.Default, Default, (w, d) => w.WriteAny(d));
 
             // nullable
-            if (version == OpenApiSpecVersion.OpenApi3_0 && serializedTypeProperty)
+            if (version == OpenApiSpecVersion.OpenApi3_0)
             {
                 // https://spec.openapis.org/oas/v3.0.4.html#fixed-fields-20
                 // This keyword only takes effect if type is explicitly defined within the same Schema Object.
                 //
-                // If the user explicitly set IsNullable to true, we serialize it even if redundant.
-                // But if **we** are inferring it (from oneOf/anyOf), we don't serialize it when it's redundant.
+                // We don't care to avoid an unnecessary serialization.
+                // So, we attempt to serialize it regardless of whether or not a type property was serialized.
                 SerializeNullable(writer, version);
             }
 
@@ -838,7 +838,7 @@ private void SerializeAsV2(
             writer.WriteStartObject();
 
             // type
-            TrySerializeTypePropertyForVersion2(writer);
+            SerializeTypePropertyForVersion2(writer);
 
             // description
             writer.WriteProperty(OpenApiConstants.Description, Description);
@@ -1006,21 +1006,18 @@ private void SerializeAsV2(
             writer.WriteEndObject();
         }
 
-        private bool TrySerializeTypePropertyForVersion2(IOpenApiWriter writer)
+        private void SerializeTypePropertyForVersion2(IOpenApiWriter writer)
         {
-            if (Type is not { } type)
+            if (Type is not { } type || type == JsonSchemaType.Null)
             {
-                return false;
+                return;
             }
 
             var typeWithoutNull = type & ~JsonSchemaType.Null;
-            if (typeWithoutNull != 0 && !HasMultipleTypes(typeWithoutNull))
+            if (!HasMultipleTypes(typeWithoutNull))
             {
                 writer.WriteProperty(OpenApiConstants.Type, typeWithoutNull.ToFirstIdentifier());
-                return true;
             }
-
-            return false;
         }
 
         /// <summary>
@@ -1030,18 +1027,18 @@ private bool TrySerializeTypePropertyForVersion2(IOpenApiWriter writer)
         /// true if the Type was serializable using "type" property, and false if
         /// it serialized using anyOf/oneOf or if it couldn't be serialized at all.
         /// </returns>
-        private bool TrySerializeTypePropertyForVersion3AndLater(IOpenApiWriter writer, OpenApiSpecVersion version, Action<IOpenApiWriter, IOpenApiSerializable> callback)
+        private void SerializeTypePropertyForVersion3AndLater(IOpenApiWriter writer, OpenApiSpecVersion version, Action<IOpenApiWriter, IOpenApiSerializable> callback)
         {
             if (Type is not { } type)
             {
-                return false;
+                return;
             }
 
             if (version == OpenApiSpecVersion.OpenApi3_0)
             {
                 if (type == JsonSchemaType.Null)
                 {
-                    return false;
+                    return;
                 }
 
                 var typeWithoutNull = type & ~JsonSchemaType.Null;
@@ -1061,18 +1058,18 @@ where typeWithoutNull.HasFlag(flag)
                     if (canWriteAsAnyOf)
                     {
                         writer.WriteOptionalCollection(OpenApiConstants.AnyOf, ConstructChildSchemasForTypes(arrayWithoutNull, hasNull), callback);
-                        return false;
+                        return;
                     }
                     else if (canWriteAsOneOf)
                     {
                         writer.WriteOptionalCollection(OpenApiConstants.OneOf, ConstructChildSchemasForTypes(arrayWithoutNull, hasNull), callback);
-                        return false;
+                        return;
                     }
                 }
                 else
                 {
                     writer.WriteProperty(OpenApiConstants.Type, arrayWithoutNull[0].ToSingleIdentifier());
-                    return true;
+                    return;
                 }
             }
             else
@@ -1089,12 +1086,8 @@ where type.HasFlag(flag)
                 {
                     writer.WriteProperty(OpenApiConstants.Type, array[0].ToSingleIdentifier());
                 }
-
-                return true;
             }
 
-            return false;
-
             static OpenApiSchema[] ConstructChildSchemasForTypes(JsonSchemaType[] types, bool hasNull)
             {
                 var schemas = new OpenApiSchema[types.Length + (hasNull ? 1 : 0)];

src/Microsoft.OpenApi/Reader/JsonNodeHelper.cs

@@ -42,7 +42,13 @@ public static List<JsonNode> CreateListOfAny(this JsonNode? node, ParsingContext
                 throw new OpenApiReaderException("Cannot create a list from this type of node.", context);
             }
 
-            return jsonArray.OfType<JsonNode>().ToList();
+            var list = new List<JsonNode>(jsonArray.Count);
+            foreach (var element in jsonArray)
+            {
+                list.Add(element ?? JsonNullSentinel.JsonNull);
+            }
+
+            return list;
         }
 
         public static List<T> CreateSimpleList<T>(this JsonNode? node, Func<JsonNode, OpenApiDocument?, T> map, OpenApiDocument? openApiDocument, ParsingContext context)

src/Microsoft.OpenApi/Reader/V3/OpenApiSchemaDeserializer.cs

@@ -413,6 +413,13 @@ public static IOpenApiSchema LoadSchema(JsonNode node, OpenApiDocument hostDocum
                 }
             }
 
+            if (schema.Type is null && schema.Enum is { Count: 1 } &&
+                schema.Enum[0].IsJsonNullSentinel())
+            {
+                schema.Enum = null;
+                schema.Type = JsonSchemaType.Null;
+            }
+
             return schema;
         }
     }

test/Microsoft.OpenApi.Tests/Models/OpenApiSchemaTests.cs

@@ -965,7 +965,8 @@ public async Task SerializeOneOfWithNullAsV3ShouldUseNullableAsync()
                     {
                       "enum": [
                         null
-                      ]
+                      ],
+                      "nullable": true
                     },
                     {
                       "maxLength": 10,
@@ -1009,7 +1010,8 @@ public async Task SerializeOneOfWithNullAndMultipleSchemasAsV3ShouldMarkItAsNull
                     {
                       "enum": [
                         null
-                      ]
+                      ],
+                      "nullable": true
                     },
                     {
                       "type": "string"
@@ -1061,7 +1063,8 @@ public async Task SerializeAnyOfWithNullAsV3ShouldUseNullableAsync()
                     {
                       "enum": [
                         null
-                      ]
+                      ],
+                      "nullable": true
                     },
                     {
                       "type": "object",
@@ -1108,7 +1111,8 @@ public async Task SerializeAnyOfWithNullAndMultipleSchemasAsV3ShouldApplyNullabl
                     {
                       "enum": [
                         null
-                      ]
+                      ],
+                      "nullable": true
                     },
                     {
                       "minLength": 1,
@@ -1153,7 +1157,8 @@ public async Task SerializeOneOfWithOnlyNullAsV3ShouldJustBeNullableAsync()
                     {
                       "enum": [
                         null
-                      ]
+                      ],
+                      "nullable": true
                     }
                   ]
                 }
@@ -1256,7 +1261,8 @@ public async Task SerializeOneOfWithNullAndRefAsV3ShouldUseNullableAsync()
                     {
                       "enum": [
                         null
-                      ]
+                      ],
+                      "nullable": true
                     },
                     {
                       "$ref": "#/components/schemas/Pet"
@@ -2050,7 +2056,8 @@ public async Task SerializeNullableEnumWith3_0()
                     {
                       "enum": [
                         null
-                      ]
+                      ],
+                      "nullable": true
                     },
                     {
                       "enum": [
@@ -2099,7 +2106,8 @@ public async Task SerializeNullableTypeWith3_0()
                 {
                   "enum": [
                     null
-                  ]
+                  ],
+                  "nullable": true
                 }
                 """;