Merge pull request #269 from Microsoft/dm/vnext/settings-fix

Fixed exposing writer Settings object

Author: darrelmiller

src/Microsoft.OpenApi.Readers/V2/OpenApiXmlDeserializer.cs

@@ -2,8 +2,10 @@
 // Licensed under the MIT license. 
 
 using System;
+using Microsoft.OpenApi.Exceptions;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Readers.Exceptions;
 using Microsoft.OpenApi.Readers.ParseNodes;
 
 namespace Microsoft.OpenApi.Readers.V2
@@ -25,7 +27,14 @@ internal static partial class OpenApiV2Deserializer
             {
                 "namespace", (o, n) =>
                 {
-                    o.Namespace = new Uri(n.GetScalarValue(), UriKind.Absolute);
+                    if (Uri.IsWellFormedUriString(n.GetScalarValue(), UriKind.Absolute))
+                    {
+                        o.Namespace = new Uri(n.GetScalarValue(), UriKind.Absolute);
+                    }
+                    else
+                    {
+                        throw new OpenApiReaderException($"Xml Namespace requires absolute URL. '{n.GetScalarValue()}' is not valid.");
+                    }
                 }
             },
             {

src/Microsoft.OpenApi/Any/OpenApiArray.cs

@@ -20,7 +20,8 @@ public class OpenApiArray : List<IOpenApiAny>, IOpenApiAny
         /// Write out contents of OpenApiArray to passed writer
         /// </summary>
         /// <param name="writer">Instance of JSON or YAML writer.</param>
-        public void Write(IOpenApiWriter writer)
+        /// <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
+        public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
         {
             writer.WriteStartArray();
 

src/Microsoft.OpenApi/Any/OpenApiNull.cs

@@ -19,7 +19,8 @@ public class OpenApiNull : IOpenApiAny
         /// Write out null representation
         /// </summary>
         /// <param name="writer"></param>
-        public void Write(IOpenApiWriter writer)
+        /// <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
+        public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
         {
             writer.WriteAny(this);
         }

src/Microsoft.OpenApi/Any/OpenApiObject.cs

@@ -20,7 +20,8 @@ public class OpenApiObject : Dictionary<string, IOpenApiAny>, IOpenApiAny
         /// Serialize OpenApiObject to writer
         /// </summary>
         /// <param name="writer"></param>
-        public void Write(IOpenApiWriter writer)
+        /// <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
+        public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
         {
             writer.WriteStartObject();
 

src/Microsoft.OpenApi/Any/OpenApiPrimitive.cs

@@ -41,7 +41,8 @@ public OpenApiPrimitive(T value)
         /// Write out content of primitive element
         /// </summary>
         /// <param name="writer"></param>
-        public void Write(IOpenApiWriter writer)
+        /// <param name="specVersion"></param>
+        public void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
         {
             switch (this.PrimitiveType)
             {

src/Microsoft.OpenApi/Extensions/OpenApiSerializableExtensions.cs

@@ -83,7 +83,7 @@ public static void Serialize<T>(
         /// <typeparam name="T">the <see cref="IOpenApiSerializable"/></typeparam>
         /// <param name="element">The Open API element.</param>
         /// <param name="writer">The output writer.</param>
-        /// <param name="specVersion">The Open API specification version.</param>
+        /// <param name="specVersion">Version of the specification the output should conform to</param>
         public static void Serialize<T>(this T element, IOpenApiWriter writer, OpenApiSpecVersion specVersion)
             where T : IOpenApiSerializable
         {
@@ -114,18 +114,6 @@ public static void Serialize<T>(this T element, IOpenApiWriter writer, OpenApiSp
             writer.Flush();
         }
 
-        /// <summary>
-        /// Serializes the <see cref="IOpenApiSerializable"/> to Open API document using the given specification version and writer.
-        /// </summary>
-        /// <typeparam name="T">the <see cref="IOpenApiSerializable"/></typeparam>
-        /// <param name="element">The Open API element.</param>
-        /// <param name="writer">The output writer.</param>
-        public static void Serialize<T>(this T element, IOpenApiWriter writer)
-            where T : IOpenApiSerializable
-        {
-            element.Serialize(writer, writer.Settings.SpecVersion);
-        }
-
         /// <summary>
         /// Serializes the <see cref="IOpenApiSerializable"/> to the Open API document as a string in JSON format.
         /// </summary>

src/Microsoft.OpenApi/Interfaces/IOpenApiExtension.cs

@@ -14,6 +14,7 @@ public interface IOpenApiExtension
         /// Write out contents of custom extension
         /// </summary>
         /// <param name="writer"></param>
-        void Write(IOpenApiWriter writer);
+        /// <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
+        void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion);
     }
 }

src/Microsoft.OpenApi/Models/OpenApiCallback.cs

@@ -94,7 +94,7 @@ public void SerializeAsV3WithoutReference(IOpenApiWriter writer)
             }
 
             // extensions
-            writer.WriteExtensions(Extensions);
+            writer.WriteExtensions(Extensions, OpenApiSpecVersion.OpenApi3_0);
 
             writer.WriteEndObject();
         }

src/Microsoft.OpenApi/Models/OpenApiComponents.cs

@@ -244,7 +244,7 @@ public void SerializeAsV3(IOpenApiWriter writer)
                 });
 
             // extensions
-            writer.WriteExtensions(Extensions);
+            writer.WriteExtensions(Extensions, OpenApiSpecVersion.OpenApi3_0);
 
             writer.WriteEndObject();
         }

src/Microsoft.OpenApi/Models/OpenApiContact.cs

@@ -40,18 +40,18 @@ public class OpenApiContact : IOpenApiSerializable, IOpenApiExtensible
         /// </summary>
         public void SerializeAsV3(IOpenApiWriter writer)
         {
-            WriteInternal(writer);
+            WriteInternal(writer, OpenApiSpecVersion.OpenApi3_0);
         }
 
         /// <summary>
         /// Serialize <see cref="OpenApiContact"/> to Open Api v2.0
         /// </summary>
         public void SerializeAsV2(IOpenApiWriter writer)
         {
-            WriteInternal(writer);
+            WriteInternal(writer, OpenApiSpecVersion.OpenApi2_0);
         }
 
-        private void WriteInternal(IOpenApiWriter writer)
+        private void WriteInternal(IOpenApiWriter writer, OpenApiSpecVersion specVersion)
         {
             if (writer == null)
             {
@@ -70,7 +70,7 @@ private void WriteInternal(IOpenApiWriter writer)
             writer.WriteProperty(OpenApiConstants.Email, Email);
 
             // extensions
-            writer.WriteExtensions(Extensions);
+            writer.WriteExtensions(Extensions, specVersion);
 
             writer.WriteEndObject();
         }