Merge remote-tracking branch 'origin/master' into dm/validation

Author: darrelmiller

src/Microsoft.OpenApi.Readers/Microsoft.OpenApi.Readers.csproj

@@ -10,7 +10,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi.Readers</Title>
         <PackageId>Microsoft.OpenApi.Readers</PackageId>
-        <Version>1.0.0-beta008</Version>
+        <Version>1.0.0-beta009</Version>
         <Description>OpenAPI.NET Readers for JSON and YAML documents</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>

src/Microsoft.OpenApi.Readers/OpenApiStreamReader.cs

@@ -65,15 +65,22 @@ public OpenApiDocument Read(Stream input, out OpenApiDiagnostic diagnostic)
 
             var inputVersion = GetVersion(rootNode);
 
-            switch (inputVersion)
+            if ( inputVersion == "2.0")
             {
-                case "2.0":
-                    context.ReferenceService = new OpenApiV2ReferenceService(rootNode);
-                    return OpenApiV2Deserializer.LoadOpenApi(rootNode);
-
-                default:
-                    context.ReferenceService = new OpenApiV3ReferenceService(rootNode);
-                    return OpenApiV3Deserializer.LoadOpenApi(rootNode);
+                context.ReferenceService = new OpenApiV2ReferenceService(rootNode);
+                return OpenApiV2Deserializer.LoadOpenApi(rootNode);
+            }
+            else if (inputVersion.StartsWith("3.0."))
+            {
+                context.ReferenceService = new OpenApiV3ReferenceService(rootNode);
+                return OpenApiV3Deserializer.LoadOpenApi(rootNode);
+            }
+            else
+            {
+                // If version number is not recognizable,
+                // our best effort will try to deserialize the document to V3.
+                context.ReferenceService = new OpenApiV3ReferenceService(rootNode);
+                return OpenApiV3Deserializer.LoadOpenApi(rootNode);
             }
         }
     }

src/Microsoft.OpenApi.Readers/ReferenceServices/OpenApiV2ReferenceService.cs

@@ -97,6 +97,7 @@ public bool TryLoadReference(OpenApiReference reference, out IOpenApiReferenceab
                     break;
 
                 case ReferenceType.Parameter:
+                    // TODO: Handle referencing to a "body" parameter in V2
                     referencedObject = OpenApiV2Deserializer.LoadParameter(node);
                     break;
 

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

@@ -202,13 +202,14 @@ private static void ProcessIn(OpenApiParameter o, ParseNode n)
                 case "body":
                     n.Context.SetTempStorage("bodyParameter", o);
                     break;
-                case "form":
+                case "formData":
                     var formParameters = n.Context.GetFromTempStorage<List<OpenApiParameter>>("formParameters");
                     if (formParameters == null)
                     {
                         formParameters = new List<OpenApiParameter>();
                         n.Context.SetTempStorage("formParameters", formParameters);
                     }
+
                     formParameters.Add(o);
                     break;
                 default:
@@ -226,11 +227,12 @@ public static OpenApiParameter LoadParameter(ParseNode node)
             var mapNode = node.CheckMapNode("parameter");
 
             var pointer = mapNode.GetReferencePointer();
+
             if (pointer != null)
             {
                 return mapNode.GetReferencedObject<OpenApiParameter>(ReferenceType.Parameter, pointer);
             }
-
+            
             var parameter = new OpenApiParameter();
 
             ParseMap(mapNode, parameter, _parameterFixedFields, _parameterPatternFields);

src/Microsoft.OpenApi.Workbench/MainModel.cs

@@ -200,7 +200,7 @@ private string WriteContents(OpenApiDocument document)
             var outputStream = new MemoryStream();
             document.Serialize(
                 outputStream,
-                IsV3 ? OpenApiSpecVersion.OpenApi3_0_0 : OpenApiSpecVersion.OpenApi2_0,
+                IsV3 ? OpenApiSpecVersion.OpenApi3_0 : OpenApiSpecVersion.OpenApi2_0,
                 _format == "Yaml" ? OpenApiFormat.Yaml : OpenApiFormat.Json);
 
             outputStream.Position = 0;

src/Microsoft.OpenApi/Extensions/OpenApiSerializableExtensions.cs

@@ -99,7 +99,7 @@ public static void Serialize<T>(this T element, IOpenApiWriter writer, OpenApiSp
 
             switch (specVersion)
             {
-                case OpenApiSpecVersion.OpenApi3_0_0:
+                case OpenApiSpecVersion.OpenApi3_0:
                     element.SerializeAsV3(writer);
                     break;
 

src/Microsoft.OpenApi/Microsoft.OpenApi.csproj

@@ -10,7 +10,7 @@
         <Company>Microsoft</Company>
         <Title>Microsoft.OpenApi</Title>
         <PackageId>Microsoft.OpenApi</PackageId>
-        <Version>1.0.0-beta008</Version>
+        <Version>1.0.0-beta009</Version>
         <Description>.NET models with JSON and YAML writers for OpenAPI specification</Description>
         <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
         <PackageTags>OpenAPI .NET</PackageTags>

src/Microsoft.OpenApi/Models/OpenApiDocument.cs

@@ -11,7 +11,7 @@
 namespace Microsoft.OpenApi.Models
 {
     /// <summary>
-    /// Describes an Open API Document. See: https://swagger.io/specification
+    /// Describes an OpenAPI object (OpenAPI document). See: https://swagger.io/specification
     /// </summary>
     public class OpenApiDocument : IOpenApiSerializable, IOpenApiExtensible
     {
@@ -57,7 +57,7 @@ public class OpenApiDocument : IOpenApiSerializable, IOpenApiExtensible
         public IDictionary<string, IOpenApiAny> Extensions { get; set; } = new Dictionary<string, IOpenApiAny>();
 
         /// <summary>
-        /// Serialize <see cref="OpenApiDocument"/> to Open Api v3.0.0
+        /// Serialize <see cref="OpenApiDocument"/> to the latest patch of OpenAPI object V3.0.
         /// </summary>
         public void SerializeAsV3(IOpenApiWriter writer)
         {
@@ -69,7 +69,7 @@ public void SerializeAsV3(IOpenApiWriter writer)
             writer.WriteStartObject();
 
             // openapi
-            writer.WriteProperty(OpenApiConstants.OpenApi, "3.0.0");
+            writer.WriteProperty(OpenApiConstants.OpenApi, "3.0.1");
 
             // info
             writer.WriteRequiredObject(OpenApiConstants.Info, Info, (w, i) => i.SerializeAsV3(w));
@@ -102,7 +102,7 @@ public void SerializeAsV3(IOpenApiWriter writer)
         }
 
         /// <summary>
-        /// Serialize <see cref="OpenApiDocument"/> to Open Api v2.0.
+        /// Serialize <see cref="OpenApiDocument"/> to OpenAPI object V2.0.
         /// </summary>
         public void SerializeAsV2(IOpenApiWriter writer)
         {

src/Microsoft.OpenApi/OpenApiSerializerSettings.cs

@@ -11,7 +11,7 @@ public sealed class OpenApiSerializerSettings
         /// <summary>
         /// Open Api specification version
         /// </summary>
-        public OpenApiSpecVersion SpecVersion { get; set; } = OpenApiSpecVersion.OpenApi3_0_0;
+        public OpenApiSpecVersion SpecVersion { get; set; } = OpenApiSpecVersion.OpenApi3_0;
 
         /// <summary>
         /// Open Api document format.

src/Microsoft.OpenApi/OpenApiSpecVersion.cs

@@ -4,18 +4,18 @@
 namespace Microsoft.OpenApi
 {
     /// <summary>
-    /// Represents the Open Api specification version.
+    /// Represents versions of OpenAPI specification.
     /// </summary>
     public enum OpenApiSpecVersion
     {
         /// <summary>
-        /// Open Api v2.0
+        /// Represents OpenAPI V2.0 spec
         /// </summary>
         OpenApi2_0,
 
         /// <summary>
-        /// Open Api v3.0.0
-        /// </summary>
-        OpenApi3_0_0
+        /// Represents all patches of OpenAPI V3.0 spec (e.g. 3.0.0, 3.0.1)
+        /// </summary> 
+        OpenApi3_0
     }
 }