Merge branch 'feat/oai-3-2-support' into copilot/fix-3c317057-370e-4d33-8171-b4b6862334fb

Author: baywet

src/Microsoft.OpenApi/Models/Interfaces/IOpenApiExample.cs

@@ -22,4 +22,20 @@ public interface IOpenApiExample : IOpenApiDescribedElement, IOpenApiSummarizedE
     /// The value field and externalValue field are mutually exclusive.
     /// </summary>
     public string? ExternalValue { get; }
+
+    /// <summary>
+    /// Embedded literal example value. 
+    /// The dataValue property and the value property are mutually exclusive.
+    /// To represent examples of media types that cannot be naturally represented in JSON or YAML,
+    /// use a string value to contain the example with escaping where necessary.
+    /// Available in OpenAPI 3.2+, serialized as extension in 3.1 and earlier.
+    /// </summary>
+    public JsonNode? DataValue { get; }
+
+    /// <summary>
+    /// A string representation of the example.
+    /// This is mutually exclusive with the value and dataValue properties.
+    /// Available in OpenAPI 3.2+, serialized as extension in 3.1 and earlier.
+    /// </summary>
+    public string? SerializedValue { get; }
 }

src/Microsoft.OpenApi/Models/OpenApiConstants.cs

@@ -345,6 +345,16 @@ public static class OpenApiConstants
         /// </summary>
         public const string ExternalValue = "externalValue";
 
+        /// <summary>
+        /// Field: DataValue
+        /// </summary>
+        public const string DataValue = "dataValue";
+
+        /// <summary>
+        /// Field: SerializedValue
+        /// </summary>
+        public const string SerializedValue = "serializedValue";
+
         /// <summary>
         /// Field: DollarRef
         /// </summary>
@@ -565,6 +575,11 @@ public static class OpenApiConstants
         /// </summary>
         public const string AuthorizationCode = "authorizationCode";
 
+        /// <summary>
+        /// Field: DeviceAuthorization
+        /// </summary>
+        public const string DeviceAuthorization = "deviceAuthorization";
+
         /// <summary>
         /// Field: AuthorizationUrl
         /// </summary>

src/Microsoft.OpenApi/Models/OpenApiExample.cs

@@ -23,6 +23,12 @@ public class OpenApiExample : IOpenApiExtensible, IOpenApiExample
         /// <inheritdoc/>
         public JsonNode? Value { get; set; }
 
+        /// <inheritdoc/>
+        public JsonNode? DataValue { get; set; }
+
+        /// <inheritdoc/>
+        public string? SerializedValue { get; set; }
+
         /// <inheritdoc/>
         public IDictionary<string, IOpenApiExtension>? Extensions { get; set; }
 
@@ -42,6 +48,8 @@ internal OpenApiExample(IOpenApiExample example)
             Description = example.Description ?? Description;
             Value = example.Value != null ? JsonNodeCloneHelper.Clone(example.Value) : null;
             ExternalValue = example.ExternalValue ?? ExternalValue;
+            DataValue = example.DataValue != null ? JsonNodeCloneHelper.Clone(example.DataValue) : null;
+            SerializedValue = example.SerializedValue ?? SerializedValue;
             Extensions = example.Extensions != null ? new Dictionary<string, IOpenApiExtension>(example.Extensions) : null;
         }
 
@@ -84,6 +92,32 @@ private void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version
             // externalValue
             writer.WriteProperty(OpenApiConstants.ExternalValue, ExternalValue);
 
+            // dataValue - serialize as native field in v3.2+, as extension in earlier versions
+            if (DataValue is not null)
+            {
+                if (version >= OpenApiSpecVersion.OpenApi3_2)
+                {
+                    writer.WriteRequiredObject(OpenApiConstants.DataValue, DataValue, (w, v) => w.WriteAny(v));
+                }
+                else
+                {
+                    writer.WriteRequiredObject(OpenApiConstants.ExtensionFieldNamePrefix + "oai-" + OpenApiConstants.DataValue, DataValue, (w, v) => w.WriteAny(v));
+                }
+            }
+
+            // serializedValue - serialize as native field in v3.2+, as extension in earlier versions
+            if (SerializedValue is not null)
+            {
+                if (version >= OpenApiSpecVersion.OpenApi3_2)
+                {
+                    writer.WriteProperty(OpenApiConstants.SerializedValue, SerializedValue);
+                }
+                else
+                {
+                    writer.WriteProperty(OpenApiConstants.ExtensionFieldNamePrefix + "oai-" + OpenApiConstants.SerializedValue, SerializedValue);
+                }
+            }
+
             // extensions
             writer.WriteExtensions(Extensions, version);
 

src/Microsoft.OpenApi/Models/OpenApiOAuthFlows.cs

@@ -31,6 +31,11 @@ public class OpenApiOAuthFlows : IOpenApiSerializable, IOpenApiExtensible
         /// </summary>
         public OpenApiOAuthFlow? AuthorizationCode { get; set; }
 
+        /// <summary>
+        /// Configuration for the OAuth Device Authorization flow.
+        /// </summary>
+        public OpenApiOAuthFlow? DeviceAuthorization { get; set; }
+
         /// <summary>
         /// Specification Extensions.
         /// </summary>
@@ -51,6 +56,7 @@ public OpenApiOAuthFlows(OpenApiOAuthFlows oAuthFlows)
             Password = oAuthFlows?.Password != null ? new(oAuthFlows.Password) : null;
             ClientCredentials = oAuthFlows?.ClientCredentials != null ? new(oAuthFlows.ClientCredentials) : null;
             AuthorizationCode = oAuthFlows?.AuthorizationCode != null ? new(oAuthFlows.AuthorizationCode) : null;
+            DeviceAuthorization = oAuthFlows?.DeviceAuthorization != null ? new(oAuthFlows.DeviceAuthorization) : null;
             Extensions = oAuthFlows?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(oAuthFlows.Extensions) : null;
         }
 
@@ -106,6 +112,22 @@ private void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version
                 AuthorizationCode,
                 callback);
 
+            // deviceAuthorization - only for v3.2+, otherwise as extension
+            if (version >= OpenApiSpecVersion.OpenApi3_2)
+            {
+                writer.WriteOptionalObject(
+                    OpenApiConstants.DeviceAuthorization,
+                    DeviceAuthorization,
+                    callback);
+            }
+            else if (DeviceAuthorization is not null)
+            {
+                writer.WriteOptionalObject(
+                    OpenApiConstants.ExtensionFieldNamePrefix + "oai-" + OpenApiConstants.DeviceAuthorization,
+                    DeviceAuthorization,
+                    callback);
+            }
+
             // extensions
             writer.WriteExtensions(Extensions, version);
 

src/Microsoft.OpenApi/Models/References/OpenApiExampleReference.cs

@@ -55,6 +55,12 @@ public string? Summary
         /// <inheritdoc/>
         public JsonNode? Value { get => Target?.Value; }
 
+        /// <inheritdoc/>
+        public JsonNode? DataValue { get => Target?.DataValue; }
+
+        /// <inheritdoc/>
+        public string? SerializedValue { get => Target?.SerializedValue; }
+
         /// <inheritdoc/>
         public override IOpenApiExample CopyReferenceAsTargetElementWithOverrides(IOpenApiExample source)
         {

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

@@ -34,6 +34,8 @@ internal static partial class OpenApiV3Deserializer
         private static readonly PatternFieldMap<OpenApiExample> _examplePatternFields =
             new()
             {
+                {s => s.Equals("x-oai-dataValue", StringComparison.OrdinalIgnoreCase), (o, p, n, _) => o.DataValue = n.CreateAny()},
+                {s => s.Equals("x-oai-serializedValue", StringComparison.OrdinalIgnoreCase), (o, p, n, _) => o.SerializedValue = n.GetScalarValue()},
                 {s => s.StartsWith(OpenApiConstants.ExtensionFieldNamePrefix, StringComparison.OrdinalIgnoreCase), (o, p, n, _) => o.AddExtension(p, LoadExtension(p,n))}
             };
 

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

@@ -23,6 +23,7 @@ internal static partial class OpenApiV3Deserializer
         private static readonly PatternFieldMap<OpenApiOAuthFlows> _oAuthFlowsPatternFields =
             new()
             {
+                {s => s.Equals("x-oai-deviceAuthorization", StringComparison.OrdinalIgnoreCase), (o, p, n, t) => o.DeviceAuthorization = LoadOAuthFlow(n, t)},
                 {s => s.StartsWith(OpenApiConstants.ExtensionFieldNamePrefix, StringComparison.OrdinalIgnoreCase), (o, p, n, _) => o.AddExtension(p, LoadExtension(p,n))}
             };
 

src/Microsoft.OpenApi/Reader/V31/OpenApiExampleDeserializer.cs

@@ -40,6 +40,8 @@ internal static partial class OpenApiV31Deserializer
         private static readonly PatternFieldMap<OpenApiExample> _examplePatternFields =
             new()
             {
+                {s => s.Equals("x-oai-dataValue", StringComparison.OrdinalIgnoreCase), (o, p, n, _) => o.DataValue = n.CreateAny()},
+                {s => s.Equals("x-oai-serializedValue", StringComparison.OrdinalIgnoreCase), (o, p, n, _) => o.SerializedValue = n.GetScalarValue()},
                 {s => s.StartsWith(OpenApiConstants.ExtensionFieldNamePrefix, StringComparison.OrdinalIgnoreCase), (o, p, n, _) => o.AddExtension(p, LoadExtension(p,n))}
             };
 

src/Microsoft.OpenApi/Reader/V31/OpenApiOAuthFlowsDeserializer.cs

@@ -20,6 +20,7 @@ internal static partial class OpenApiV31Deserializer
         private static readonly PatternFieldMap<OpenApiOAuthFlows> _oAuthFlowsPatternFields =
             new()
             {
+                {s => s.Equals("x-oai-deviceAuthorization", StringComparison.OrdinalIgnoreCase), (o, p, n, t) => o.DeviceAuthorization = LoadOAuthFlow(n, t)},
                 {s => s.StartsWith(OpenApiConstants.ExtensionFieldNamePrefix, StringComparison.OrdinalIgnoreCase), (o, p, n, _) => o.AddExtension(p, LoadExtension(p,n))}
             };
 

src/Microsoft.OpenApi/Reader/V32/OpenApiExampleDeserializer.cs

@@ -34,6 +34,18 @@ internal static partial class OpenApiV32Deserializer
                     o.ExternalValue = n.GetScalarValue();
                 }
             },
+            {
+                "dataValue", (o, n, _) =>
+                {
+                    o.DataValue = n.CreateAny();
+                }
+            },
+            {
+                "serializedValue", (o, n, _) =>
+                {
+                    o.SerializedValue = n.GetScalarValue();
+                }
+            },
 
         };