Merge branch 'master' into dm/OpenApiAny

Author: darrelmiller

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

@@ -19,12 +19,7 @@ internal static partial class OpenApiV2Deserializer
     {
         public static FixedFieldMap<OpenApiDocument> OpenApiFixedFields = new FixedFieldMap<OpenApiDocument>
         {
-            {
-                "swagger", (o, n) =>
-                {
-                    o.SpecVersion = new Version(2, 0);
-                }
-            },
+            {"swagger", (o, n) => { } /* Version is valid field but we already parsed it */  },
             {"info", (o, n) => o.Info = LoadInfo(n)},
             {"host", (o, n) => n.Context.SetTempStorage("host", n.GetScalarValue())},
             {"basePath", (o, n) => n.Context.SetTempStorage("basePath", n.GetScalarValue())},
@@ -45,20 +40,36 @@ internal static partial class OpenApiV2Deserializer
             {"paths", (o, n) => o.Paths = LoadPaths(n)},
             {
                 "definitions",
-                (o, n) => o.Components.Schemas = n.CreateMapWithReference(
+                (o, n) => {
+                    o.Components = new OpenApiComponents();
+                    o.Components.Schemas = n.CreateMapWithReference(
                     ReferenceType.Schema,
                     "#/definitions/",
-                    LoadSchema)
+                    LoadSchema);
+                    }
             },
             {
                 "parameters",
-                (o, n) => o.Components.Parameters = n.CreateMapWithReference(
+                (o, n) => {
+                    o.Components = new OpenApiComponents();
+                    o.Components.Parameters = n.CreateMapWithReference(
                     ReferenceType.Parameter,
                     "#/parameters/",
-                    LoadParameter)
+                    LoadParameter);
+                    }
+            },
+            {
+                "responses", (o, n) => {
+                o.Components = new OpenApiComponents();
+                o.Components.Responses = n.CreateMap(LoadResponse);
+                }
+            },
+            {
+                "securityDefinitions", (o, n) => {
+                o.Components = new OpenApiComponents();
+                o.Components.SecuritySchemes = n.CreateMap(LoadSecurityScheme);
+                }
             },
-            {"responses", (o, n) => o.Components.Responses = n.CreateMap(LoadResponse)},
-            {"securityDefinitions", (o, n) => o.Components.SecuritySchemes = n.CreateMap(LoadSecurityScheme)},
             {"security", (o, n) => o.SecurityRequirements = n.CreateList(LoadSecurityRequirement)},
             {"tags", (o, n) => o.Tags = n.CreateList(LoadTag)},
             {"externalDocs", (o, n) => o.ExternalDocs = LoadExternalDocs(n)}

src/Microsoft.OpenApi.Readers/V3/OpenApiDocumentDeserializer.cs

@@ -19,12 +19,7 @@ internal static partial class OpenApiV3Deserializer
     {
         public static FixedFieldMap<OpenApiDocument> OpenApiFixedFields = new FixedFieldMap<OpenApiDocument>
         {
-            {
-                "openapi", (o, n) =>
-                {
-                    o.SpecVersion = new Version(n.GetScalarValue());
-                }
-            },
+            {"openapi", (o, n) => { } /* Version is valid field but we already parsed it */  },
             {"info", (o, n) => o.Info = LoadInfo(n)},
             {"servers", (o, n) => o.Servers = n.CreateList(LoadServer)},
             {"paths", (o, n) => o.Paths = LoadPaths(n)},

src/Microsoft.OpenApi/Models/OpenApiDocument.cs

@@ -17,11 +17,6 @@ namespace Microsoft.OpenApi.Models
     /// </summary>
     public class OpenApiDocument : IOpenApiSerializable, IOpenApiExtensible
     {
-        /// <summary>
-        /// REQUIRED. This string MUST be the semantic version number of the OpenAPI Specification version 
-        /// that the OpenAPI document uses.
-        /// </summary>
-        public Version SpecVersion { get; set; }
 
         /// <summary>
         /// REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.
@@ -64,7 +59,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.
+        /// Serialize <see cref="OpenApiDocument"/> to Open Api v3.0.0
         /// </summary>
         public void SerializeAsV3(IOpenApiWriter writer)
         {
@@ -76,7 +71,7 @@ public void SerializeAsV3(IOpenApiWriter writer)
             writer.WriteStartObject();
 
             // openapi
-            writer.WriteProperty(OpenApiConstants.OpenApi, SpecVersion?.ToString());
+            writer.WriteProperty(OpenApiConstants.OpenApi, "3.0.0");
 
             // info
             writer.WriteRequiredObject(OpenApiConstants.Info, Info, (w, i) => i.SerializeAsV3(w));
@@ -118,7 +113,7 @@ public void SerializeAsV2(IOpenApiWriter writer)
             writer.WriteStartObject();
 
             // swagger
-            writer.WriteProperty(OpenApiConstants.Swagger, SpecVersion?.ToString());
+            writer.WriteProperty(OpenApiConstants.Swagger, "2.0");
 
             // info
             writer.WriteRequiredObject(OpenApiConstants.Info, Info, (w, i) => i.SerializeAsV2(w));

src/Microsoft.OpenApi/Models/OpenApiPathItem.cs

@@ -46,7 +46,7 @@ public class OpenApiPathItem : IOpenApiSerializable, IOpenApiExtensible
         /// <summary>
         /// This object MAY be extended with Specification Extensions.
         /// </summary>
-        public IDictionary<string, IOpenApiAny> Extensions { get; set; }
+        public IDictionary<string, IOpenApiAny> Extensions { get; set; } = new Dictionary<string, IOpenApiAny>();
 
         /// <summary>
         /// Add one operation into this path item.

src/Microsoft.OpenApi/Writers/OpenApiWriterExtensions.cs

@@ -7,6 +7,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.OpenApi.Interfaces;
+using System.Collections;
 
 namespace Microsoft.OpenApi.Writers
 {
@@ -123,6 +124,11 @@ public static void WriteOptionalObject<T>(
         {
             if (value != null)
             {
+                IEnumerable values = value as IEnumerable;
+                if (values != null && !values.GetEnumerator().MoveNext() )
+                {
+                    return;  // Don't render optional empty collections
+                }
                 writer.WriteRequiredObject(name, value, action);
             }
         }

test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj

@@ -47,12 +47,18 @@
     <None Update="V2Tests\Samples\basic.v3.yaml">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Update="V2Tests\Samples\definitions.v3.yaml">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="V2Tests\Samples\host.v2.yaml">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
     <None Update="V2Tests\Samples\host.v3.yaml">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Update="V2Tests\Samples\definitions.v2.yaml">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="V2Tests\Samples\minimal.v3.yaml">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

test/Microsoft.OpenApi.Readers.Tests/V2Tests/ComparisonTests.cs

@@ -18,6 +18,7 @@ public class ComparisonTests
         [Theory]
         [InlineData("minimal")]
         [InlineData("basic")]
+        //[InlineData("definitions")]  //Currently broken due to V3 references not behaving the same as V2
         public void EquivalentV2AndV3DocumentsShouldProductEquivalentObjects(string fileName)
         {
             using (var streamV2 = File.OpenRead(Path.Combine(SampleFolderPath, $"{fileName}.v2.yaml")))
@@ -29,9 +30,7 @@ public void EquivalentV2AndV3DocumentsShouldProductEquivalentObjects(string file
                 // Everything in the DOM read from V2 and V3 documents should be equal
                 // except the SpecVersion property (2.0 and 3.0.0)
                 openApiDocV3.ShouldBeEquivalentTo(
-                    openApiDocV2,
-                    options => options.Excluding(
-                        s => s.SelectedMemberPath == nameof(OpenApiDocument.SpecVersion)));
+                    openApiDocV2);
 
                 contextV2.ShouldBeEquivalentTo(contextV3);
             }

test/Microsoft.OpenApi.Readers.Tests/V2Tests/Samples/definitions.v2.yaml

@@ -0,0 +1,17 @@
+swagger: 2.0
+info: 
+  title: This is a simple example
+  version: 1.0.0
+paths:
+  '/':
+    get:
+      produces:
+        - application/json
+      200: 
+        description: Ok
+        schema:
+          $ref: '#/definitions/simple'
+definitions:
+  simple:
+    type: string
+        

test/Microsoft.OpenApi.Readers.Tests/V2Tests/Samples/definitions.v3.yaml

@@ -0,0 +1,18 @@
+openapi: 3.0
+info: 
+  title: This is a simple example
+  version: 1.0.0
+paths:
+  '/':
+    get:
+      200: 
+        description: Ok
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/simple'
+components:
+  schemas:
+    simple:
+      type: string
+        

test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDocumentTests.cs

@@ -40,7 +40,6 @@ public void ParseDocumentFromInlineStringShouldSucceed()
 
             openApiDoc.ShouldBeEquivalentTo(new OpenApiDocument()
             {
-                SpecVersion = new Version(3, 0, 0),
                 Info = new OpenApiInfo
                 {
 
@@ -66,7 +65,6 @@ public void ParseBasicDocumentWithMultipleServersShouldSucceed()
 
                 openApiDoc.ShouldBeEquivalentTo(new OpenApiDocument()
                 {
-                    SpecVersion = new Version(3,0,0),
                     Info = new OpenApiInfo()
                     {
                         Title = "The API",
@@ -98,7 +96,6 @@ public void ParseBrokenMinimalDocumentShouldYieldExpectedDiagnostic()
 
                 openApiDoc.ShouldBeEquivalentTo(new OpenApiDocument()
                 {
-                    SpecVersion = new Version(3, 0, 0),
                     Info = new OpenApiInfo
                     {
                         Version = "0.9"
@@ -124,7 +121,6 @@ public void ParseMinimalDocumentShouldSucceed()
 
                 openApiDoc.ShouldBeEquivalentTo(new OpenApiDocument()
                 {
-                    SpecVersion = new Version(3, 0, 0),
                     Info = new OpenApiInfo
                     {
 
@@ -253,7 +249,6 @@ public void ParseStandardPetStoreDocumentShouldSucceed()
 
                 var expected = new OpenApiDocument()
                 {
-                    SpecVersion = new Version(3, 0, 0),
                     Info = new OpenApiInfo()
                     {
                         Version = "1.0.0",
@@ -711,7 +706,6 @@ public void ParseModifiedPetStoreDocumentWithTagAndSecurityShouldSucceed()
 
                 var expected = new OpenApiDocument()
                 {
-                    SpecVersion = new Version(3, 0, 0),
                     Info = new OpenApiInfo()
                     {
                         Version = "1.0.0",