Use JsonNode in place of OpenApiAny for Enums and Examples

Author: MaggieKimani1

src/Microsoft.OpenApi/Any/OpenApiAny.cs

@@ -35,7 +35,7 @@ public OpenApiAny(JsonNode jsonNode)
         /// <param name="specVersion"></param>
         public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
         {
-            writer.WriteAny(new OpenApiAny(Node));
+            writer.WriteAny(Node);
         }
     }
 }

src/Microsoft.OpenApi/Helpers/JsonNodeCloneHelper.cs

@@ -15,16 +15,16 @@ internal static class JsonNodeCloneHelper
             ReferenceHandler = ReferenceHandler.IgnoreCycles
         };
 
-        internal static OpenApiAny Clone(OpenApiAny value)
+        internal static JsonNode Clone(JsonNode value)
         {
-            var jsonString = Serialize(value?.Node);
+            var jsonString = Serialize(value);
             if (string.IsNullOrEmpty(jsonString))
             {
                 return null;
             }
 
             var result = JsonSerializer.Deserialize<JsonNode>(jsonString, options);
-            return new OpenApiAny(result);
+            return result;
         }
 
         private static string Serialize(object obj)

src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiDeprecationExtension.cs

@@ -77,9 +77,9 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
     /// <param name="source">The source object.</param>
     /// <returns>The <see cref="OpenApiDeprecationExtension"/>.</returns>
     /// <exception cref="ArgumentOutOfRangeException">When the source element is not an object</exception>
-    public static OpenApiDeprecationExtension Parse(OpenApiAny source)
+    public static OpenApiDeprecationExtension Parse(JsonNode source)
     {
-        if (source.Node is not JsonObject rawObject) return null;
+        if (source is not JsonObject rawObject) return null;
         var extension = new OpenApiDeprecationExtension();
         if (rawObject.TryGetPropertyValue(nameof(RemovalDate).ToFirstCharacterLowerCase(), out var removalDate) && removalDate is JsonNode removalDateValue)
             extension.RemovalDate = removalDateValue.GetValue<DateTimeOffset>();

src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiEnumFlagsExtension.cs

@@ -1,4 +1,4 @@
-// ------------------------------------------------------------
+// ------------------------------------------------------------
 //  Copyright (c) Microsoft Corporation.  All rights reserved.
 //  Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
 // ------------------------------------------------------------
@@ -44,9 +44,9 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
     /// <param name="source">The source element to parse.</param>
     /// <returns>The <see cref="OpenApiEnumFlagsExtension"/>.</returns>
     /// <exception cref="ArgumentOutOfRangeException">When the source element is not an object</exception>
-    public static OpenApiEnumFlagsExtension Parse(OpenApiAny source)
+    public static OpenApiEnumFlagsExtension Parse(JsonNode source)
     {
-        if (source.Node is not JsonObject rawObject) throw new ArgumentOutOfRangeException(nameof(source));
+        if (source is not JsonObject rawObject) throw new ArgumentOutOfRangeException(nameof(source));
         var extension = new OpenApiEnumFlagsExtension();
         if (rawObject.TryGetPropertyValue(nameof(IsFlags).ToFirstCharacterLowerCase(), out var flagsValue) && flagsValue is JsonNode isFlags)
         {

src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiEnumValuesDescriptionExtension.cs

@@ -63,9 +63,9 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
     /// <param name="source">The source element to parse.</param>
     /// <returns>The <see cref="OpenApiEnumValuesDescriptionExtension"/>.</returns>
     /// <exception cref="ArgumentOutOfRangeException">When the source element is not an object</exception>
-    public static OpenApiEnumValuesDescriptionExtension Parse(OpenApiAny source)
+    public static OpenApiEnumValuesDescriptionExtension Parse(JsonNode source)
     {
-        if (source.Node is not JsonObject rawObject) return null;
+        if (source is not JsonObject rawObject) return null;
         var extension = new OpenApiEnumValuesDescriptionExtension();
         if (rawObject.TryGetPropertyValue("values", out var values) && values is JsonArray valuesArray)
         {

src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiPagingExtension.cs

@@ -72,9 +72,9 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
     /// <param name="source">The source element to parse.</param>
     /// <returns>The <see cref="OpenApiPagingExtension"/>.</returns>
     /// <exception cref="ArgumentOutOfRangeException">When the source element is not an object</exception>
-    public static OpenApiPagingExtension Parse(OpenApiAny source)
+    public static OpenApiPagingExtension Parse(JsonNode source)
     {
-        if (source.Node is not JsonObject rawObject) return null;
+        if (source is not JsonObject rawObject) return null;
         var extension = new OpenApiPagingExtension();
         if (rawObject.TryGetPropertyValue(nameof(NextLinkName).ToFirstCharacterLowerCase(), out var nextLinkName) && nextLinkName is JsonNode nextLinkNameStr)
         {

src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiPrimaryErrorMessageExtension.cs

@@ -38,9 +38,9 @@ public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
     /// </summary>
     /// <param name="source">The source object.</param>
     /// <returns>The <see cref="OpenApiPrimaryErrorMessageExtension"/>.</returns>
-    public static OpenApiPrimaryErrorMessageExtension Parse(OpenApiAny source)
+    public static OpenApiPrimaryErrorMessageExtension Parse(JsonNode source)
     {
-        if (source.Node is not JsonNode rawObject) return null;
+        if (source is not JsonNode rawObject) return null;
         return new()
         {
             IsPrimaryErrorMessage = rawObject.GetValue<bool>()

src/Microsoft.OpenApi/MicrosoftExtensions/OpenApiReservedParameterExtension.cs

@@ -40,9 +40,9 @@ public bool? IsReserved
     /// <param name="source">The source object.</param>
     /// <returns>The <see cref="OpenApiReservedParameterExtension"/>.</returns>
     /// <returns></returns>
-    public static OpenApiReservedParameterExtension Parse(OpenApiAny source)
+    public static OpenApiReservedParameterExtension Parse(JsonNode source)
     {
-        if (source.Node is not JsonNode rawBoolean) return null;
+        if (source is not JsonNode rawBoolean) return null;
         return new()
         {
             IsReserved = rawBoolean.GetValue<bool>()

src/Microsoft.OpenApi/Models/OpenApiExample.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Text.Json.Nodes;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Helpers;
 using Microsoft.OpenApi.Interfaces;
@@ -31,7 +32,7 @@ public class OpenApiExample : IOpenApiReferenceable, IOpenApiExtensible
         /// exclusive. To represent examples of media types that cannot naturally represented
         /// in JSON or YAML, use a string value to contain the example, escaping where necessary.
         /// </summary>
-        public virtual OpenApiAny Value { get; set; }
+        public virtual JsonNode Value { get; set; }
 
         /// <summary>
         /// A URL that points to the literal example.

src/Microsoft.OpenApi/Models/OpenApiHeader.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Text.Json.Nodes;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Helpers;
@@ -77,7 +78,7 @@ public virtual OpenApiSchema Schema
         /// <summary>
         /// Example of the media type.
         /// </summary>
-        public virtual OpenApiAny Example { get; set; }
+        public virtual JsonNode Example { get; set; }
 
         /// <summary>
         /// Examples of the media type.