Merge pull request #245 from Meir017/fix/open-api-schema-required-property

PerthCharern · web-flow · commit 3669c568798e · 2018-04-26T13:39:20.000-07:00
Changed OpenApiSchema.Required to ISet
diff --git a/src/Microsoft.OpenApi.Readers/V2/OpenApiOperationDeserializer.cs b/src/Microsoft.OpenApi.Readers/V2/OpenApiOperationDeserializer.cs
@@ -160,7 +160,7 @@ private static OpenApiRequestBody CreateFormBody(ParsingContext context, List<Op
                             schema.Description = v.Description;
                             return schema;
                         }),
-                    Required = formParameters.Where(p => p.Required).Select(p => p.Name).ToList()
+                    Required = new HashSet<string>(formParameters.Where(p => p.Required).Select(p => p.Name))
                 }
             };
             
diff --git a/src/Microsoft.OpenApi.Readers/V2/OpenApiSchemaDeserializer.cs b/src/Microsoft.OpenApi.Readers/V2/OpenApiSchemaDeserializer.cs
@@ -5,6 +5,7 @@
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.ParseNodes;
+using System.Collections.Generic;
 
 namespace Microsoft.OpenApi.Readers.V2
 {
@@ -103,7 +104,7 @@ internal static partial class OpenApiV2Deserializer
             {
                 "required", (o, n) =>
                 {
-                    o.Required = n.CreateSimpleList(n2 => n2.GetScalarValue()).ToArray();
+                    o.Required = new HashSet<string>(n.CreateSimpleList(n2 => n2.GetScalarValue()));
                 }
             },
             {
diff --git a/src/Microsoft.OpenApi.Readers/V3/OpenApiSchemaDeserializer.cs b/src/Microsoft.OpenApi.Readers/V3/OpenApiSchemaDeserializer.cs
@@ -5,6 +5,7 @@
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Readers.ParseNodes;
+using System.Collections.Generic;
 
 namespace Microsoft.OpenApi.Readers.V3
 {
@@ -103,7 +104,7 @@ internal static partial class OpenApiV3Deserializer
             {
                 "required", (o, n) =>
                 {
-                    o.Required = n.CreateSimpleList(n2 => n2.GetScalarValue()).ToArray();
+                    o.Required = new HashSet<string>(n.CreateSimpleList(n2 => n2.GetScalarValue()));
                 }
             },
             {
diff --git a/src/Microsoft.OpenApi/Models/OpenApiSchema.cs b/src/Microsoft.OpenApi/Models/OpenApiSchema.cs
@@ -133,7 +133,7 @@ public class OpenApiSchema : IOpenApiSerializable, IOpenApiReferenceable, IOpenA
         /// <summary>
         /// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
         /// </summary>
-        public IList<string> Required { get; set; } = new List<string>();
+        public ISet<string> Required { get; set; } = new HashSet<string>();
 
         /// <summary>
         /// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
@@ -393,7 +393,7 @@ public void SerializeAsV3WithoutReference(IOpenApiWriter writer)
         /// </summary>
         public void SerializeAsV2(IOpenApiWriter writer)
         {
-            SerializeAsV2(writer: writer, parentRequiredProperties: new List<string>(), propertyName: null);
+            SerializeAsV2(writer: writer, parentRequiredProperties: new HashSet<string>(), propertyName: null);
         }
 
         /// <summary>
@@ -403,7 +403,7 @@ public void SerializeAsV2WithoutReference(IOpenApiWriter writer)
         {
             SerializeAsV2WithoutReference(
                 writer: writer,
-                parentRequiredProperties: new List<string>(),
+                parentRequiredProperties: new HashSet<string>(),
                 propertyName: null);
         }
 
@@ -416,7 +416,7 @@ public void SerializeAsV2WithoutReference(IOpenApiWriter writer)
         /// <param name="propertyName">The property name that will be serialized.</param>
         internal void SerializeAsV2(
             IOpenApiWriter writer,
-            IList<string> parentRequiredProperties,
+            ISet<string> parentRequiredProperties,
             string propertyName)
         {
             if (writer == null)
@@ -432,7 +432,7 @@ internal void SerializeAsV2(
 
             if (parentRequiredProperties == null)
             {
-                parentRequiredProperties = new List<string>();
+                parentRequiredProperties = new HashSet<string>();
             }
 
             SerializeAsV2WithoutReference(writer, parentRequiredProperties, propertyName);
@@ -447,7 +447,7 @@ internal void SerializeAsV2(
         /// <param name="propertyName">The property name that will be serialized.</param>
         internal void SerializeAsV2WithoutReference(
             IOpenApiWriter writer,
-            IList<string> parentRequiredProperties,
+            ISet<string> parentRequiredProperties,
             string propertyName)
         {
             writer.WriteStartObject();
@@ -521,7 +521,7 @@ internal void WriteAsItemsProperties(IOpenApiWriter writer)
 
         internal void WriteAsSchemaProperties(
             IOpenApiWriter writer,
-            IList<string> parentRequiredProperties,
+            ISet<string> parentRequiredProperties,
             string propertyName)
         {
             if (writer == null)
diff --git a/src/Microsoft.OpenApi/Writers/OpenApiWriterExtensions.cs b/src/Microsoft.OpenApi/Writers/OpenApiWriterExtensions.cs
@@ -171,7 +171,7 @@ public static void WriteRequiredObject<T>(
         public static void WriteOptionalCollection(
             this IOpenApiWriter writer,
             string name,
-            IList<string> elements,
+            IEnumerable<string> elements,
             Action<IOpenApiWriter, string> action)
         {
             if (elements != null && elements.Any())
@@ -191,7 +191,7 @@ public static void WriteOptionalCollection(
         public static void WriteOptionalCollection<T>(
             this IOpenApiWriter writer,
             string name,
-            IList<T> elements,
+            IEnumerable<T> elements,
             Action<IOpenApiWriter, T> action)
             where T : IOpenApiElement
         {
diff --git a/test/Microsoft.OpenApi.Readers.Tests/ReferenceService/TryLoadReferenceV2Tests.cs b/test/Microsoft.OpenApi.Readers.Tests/ReferenceService/TryLoadReferenceV2Tests.cs
@@ -226,7 +226,7 @@ public void LoadResponseAndSchemaReference()
                             Schema = new OpenApiSchema
                             {
                                 Description = "Sample description",
-                                Required = new List<string> {"name" },
+                                Required = new HashSet<string> {"name" },
                                 Properties = {
                                     ["name"] = new OpenApiSchema()
                                     {
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiOperationTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiOperationTests.cs
@@ -92,7 +92,7 @@ public class OpenApiOperationTests
                                         Type = "string"
                                     }
                                 },
-                                Required = new List<string>
+                                Required = new HashSet<string>
                                 {
                                     "name"
                                 }
@@ -115,7 +115,7 @@ public class OpenApiOperationTests
                                         Type = "string"
                                     }
                                 },
-                                Required = new List<string>
+                                Required = new HashSet<string>
                                 {
                                     "name"
                                 }
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiPathItemTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiPathItemTests.cs
@@ -81,7 +81,7 @@ public class OpenApiPathItemTests
                                             Type = "string"
                                         }
                                     },
-                                    Required = new List<string>
+                                    Required = new HashSet<string>
                                     {
                                         "name"
                                     }
@@ -104,7 +104,7 @@ public class OpenApiPathItemTests
                                             Type = "string"
                                         }
                                     },
-                                    Required = new List<string>
+                                    Required = new HashSet<string>
                                     {
                                         "name"
                                     }
@@ -190,7 +190,7 @@ public class OpenApiPathItemTests
                                             Type = "string"
                                         }
                                     },
-                                    Required = new List<string>
+                                    Required = new HashSet<string>
                                     {
                                         "name"
                                     }
@@ -218,7 +218,7 @@ public class OpenApiPathItemTests
                                             Type = "string"
                                         }
                                     },
-                                    Required = new List<string>
+                                    Required = new HashSet<string>
                                     {
                                         "name"
                                     }
diff --git a/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDocumentTests.cs b/test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiDocumentTests.cs
@@ -153,7 +153,7 @@ public void ParseStandardPetStoreDocumentShouldSucceed()
                         ["pet"] = new OpenApiSchema
                         {
                             Type = "object",
-                            Required = new List<string>
+                            Required = new HashSet<string>
                             {
                                 "id",
                                 "name"
@@ -183,7 +183,7 @@ public void ParseStandardPetStoreDocumentShouldSucceed()
                         ["newPet"] = new OpenApiSchema
                         {
                             Type = "object",
-                            Required = new List<string>
+                            Required = new HashSet<string>
                             {
                                 "name"
                             },
@@ -212,7 +212,7 @@ public void ParseStandardPetStoreDocumentShouldSucceed()
                         ["errorModel"] = new OpenApiSchema
                         {
                             Type = "object",
-                            Required = new List<string>
+                            Required = new HashSet<string>
                             {
                                 "code",
                                 "message"
@@ -580,7 +580,7 @@ public void ParseModifiedPetStoreDocumentWithTagAndSecurityShouldSucceed()
                         ["pet"] = new OpenApiSchema
                         {
                             Type = "object",
-                            Required = new List<string>
+                            Required = new HashSet<string>
                             {
                                 "id",
                                 "name"
@@ -610,7 +610,7 @@ public void ParseModifiedPetStoreDocumentWithTagAndSecurityShouldSucceed()
                         ["newPet"] = new OpenApiSchema
                         {
                             Type = "object",
-                            Required = new List<string>
+                            Required = new HashSet<string>
                             {
                                 "name"
                             },
@@ -639,7 +639,7 @@ public void ParseModifiedPetStoreDocumentWithTagAndSecurityShouldSucceed()
                         ["errorModel"] = new OpenApiSchema
                         {
                             Type = "object",
-                            Required = new List<string>
+                            Required = new HashSet<string>
                             {
                                 "code",
                                 "message"
diff --git a/test/Microsoft.OpenApi.Tests/Models/OpenApiDocumentTests.cs b/test/Microsoft.OpenApi.Tests/Models/OpenApiDocumentTests.cs
@@ -125,7 +125,7 @@ public class OpenApiDocumentTests
                 ["pet"] = new OpenApiSchema
                 {
                     Type = "object",
-                    Required = new List<string>
+                    Required = new HashSet<string>
                     {
                         "id",
                         "name"
@@ -155,7 +155,7 @@ public class OpenApiDocumentTests
                 ["newPet"] = new OpenApiSchema
                 {
                     Type = "object",
-                    Required = new List<string>
+                    Required = new HashSet<string>
                     {
                         "name"
                     },
@@ -184,7 +184,7 @@ public class OpenApiDocumentTests
                 ["errorModel"] = new OpenApiSchema
                 {
                     Type = "object",
-                    Required = new List<string>
+                    Required = new HashSet<string>
                     {
                         "code",
                         "message"
@@ -516,7 +516,7 @@ public class OpenApiDocumentTests
                 ["pet"] = new OpenApiSchema
                 {
                     Type = "object",
-                    Required = new List<string>
+                    Required = new HashSet<string>
                     {
                         "id",
                         "name"
@@ -541,7 +541,7 @@ public class OpenApiDocumentTests
                 ["newPet"] = new OpenApiSchema
                 {
                     Type = "object",
-                    Required = new List<string>
+                    Required = new HashSet<string>
                     {
                         "name"
                     },
@@ -565,7 +565,7 @@ public class OpenApiDocumentTests
                 ["errorModel"] = new OpenApiSchema
                 {
                     Type = "object",
-                    Required = new List<string>
+                    Required = new HashSet<string>
                     {
                         "code",
                         "message"
diff --git a/test/Microsoft.OpenApi.Tests/Models/OpenApiOperationTests.cs b/test/Microsoft.OpenApi.Tests/Models/OpenApiOperationTests.cs
@@ -251,7 +251,7 @@ [new OpenApiSecurityScheme
                                         Type = "string"
                                     }
                                 },
-                                Required = new List<string>()
+                                Required = new HashSet<string>()
                                 {
                                     "name"
                                 }
@@ -274,7 +274,7 @@ [new OpenApiSecurityScheme
                                         Type = "string"
                                     }
                                 },
-                                Required = new List<string>()
+                                Required = new HashSet<string>()
                                 {
                                     "name"
                                 }
diff --git a/test/Microsoft.OpenApi.Tests/Models/OpenApiSchemaTests.cs b/test/Microsoft.OpenApi.Tests/Models/OpenApiSchemaTests.cs
@@ -163,12 +163,12 @@ public class OpenApiSchemaTests
         public static OpenApiSchema AdvancedSchemaWithRequiredPropertiesObject = new OpenApiSchema
         {
             Title = "title1",
-            Required = new List<string>(){ "property1" },
+            Required = new HashSet<string>(){ "property1" },
             Properties = new Dictionary<string, OpenApiSchema>
             {
                 ["property1"] = new OpenApiSchema
                 {
-                    Required = new List<string>() { "property3" },
+                    Required = new HashSet<string>() { "property3" },
                     Properties = new Dictionary<string, OpenApiSchema>
                     {
                         ["property2"] = new OpenApiSchema

Original file line number	Diff line number	Diff line change
`@@ -160,7 +160,7 @@ private static OpenApiRequestBody CreateFormBody(ParsingContext context, List<Op`
`160`	`160`	`schema.Description = v.Description;`
`161`	`161`	`return schema;`
`162`	`162`	`}),`
`163`		`- Required = formParameters.Where(p => p.Required).Select(p => p.Name).ToList()`
	`163`	`+ Required = new HashSet<string>(formParameters.Where(p => p.Required).Select(p => p.Name))`
`164`	`164`	`}`
`165`	`165`	`};`
`166`	`166`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`using Microsoft.OpenApi.Extensions;`
`6`	`6`	`using Microsoft.OpenApi.Models;`
`7`	`7`	`using Microsoft.OpenApi.Readers.ParseNodes;`
	`8`	`+using System.Collections.Generic;`
`8`	`9`
`9`	`10`	`namespace Microsoft.OpenApi.Readers.V2`
`10`	`11`	`{`
`@@ -103,7 +104,7 @@ internal static partial class OpenApiV2Deserializer`
`103`	`104`	`{`
`104`	`105`	`"required", (o, n) =>`
`105`	`106`	`{`
`106`		`- o.Required = n.CreateSimpleList(n2 => n2.GetScalarValue()).ToArray();`
	`107`	`+ o.Required = new HashSet<string>(n.CreateSimpleList(n2 => n2.GetScalarValue()));`
`107`	`108`	`}`
`108`	`109`	`},`
`109`	`110`	`{`
Original file line number	Diff line number	Diff line change
`@@ -226,7 +226,7 @@ public void LoadResponseAndSchemaReference()`
`226`	`226`	`Schema = new OpenApiSchema`
`227`	`227`	`{`
`228`	`228`	`Description = "Sample description",`
`229`		`- Required = new List<string> {"name" },`
	`229`	`+ Required = new HashSet<string> {"name" },`
`230`	`230`	`Properties = {`
`231`	`231`	`["name"] = new OpenApiSchema()`
`232`	`232`	`{`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ public class OpenApiOperationTests`
`92`	`92`	`Type = "string"`
`93`	`93`	`}`
`94`	`94`	`},`
`95`		`- Required = new List<string>`
	`95`	`+ Required = new HashSet<string>`
`96`	`96`	`{`
`97`	`97`	`"name"`
`98`	`98`	`}`
`@@ -115,7 +115,7 @@ public class OpenApiOperationTests`
`115`	`115`	`Type = "string"`
`116`	`116`	`}`
`117`	`117`	`},`
`118`		`- Required = new List<string>`
	`118`	`+ Required = new HashSet<string>`
`119`	`119`	`{`
`120`	`120`	`"name"`
`121`	`121`	`}`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ public class OpenApiPathItemTests`
`81`	`81`	`Type = "string"`
`82`	`82`	`}`
`83`	`83`	`},`
`84`		`- Required = new List<string>`
	`84`	`+ Required = new HashSet<string>`
`85`	`85`	`{`
`86`	`86`	`"name"`
`87`	`87`	`}`
`@@ -104,7 +104,7 @@ public class OpenApiPathItemTests`
`104`	`104`	`Type = "string"`
`105`	`105`	`}`
`106`	`106`	`},`
`107`		`- Required = new List<string>`
	`107`	`+ Required = new HashSet<string>`
`108`	`108`	`{`
`109`	`109`	`"name"`
`110`	`110`	`}`
`@@ -190,7 +190,7 @@ public class OpenApiPathItemTests`
`190`	`190`	`Type = "string"`
`191`	`191`	`}`
`192`	`192`	`},`
`193`		`- Required = new List<string>`
	`193`	`+ Required = new HashSet<string>`
`194`	`194`	`{`
`195`	`195`	`"name"`
`196`	`196`	`}`
`@@ -218,7 +218,7 @@ public class OpenApiPathItemTests`
`218`	`218`	`Type = "string"`
`219`	`219`	`}`
`220`	`220`	`},`
`221`		`- Required = new List<string>`
	`221`	`+ Required = new HashSet<string>`
`222`	`222`	`{`
`223`	`223`	`"name"`
`224`	`224`	`}`
Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ public void ParseStandardPetStoreDocumentShouldSucceed()`
`153`	`153`	`["pet"] = new OpenApiSchema`
`154`	`154`	`{`
`155`	`155`	`Type = "object",`
`156`		`- Required = new List<string>`
	`156`	`+ Required = new HashSet<string>`
`157`	`157`	`{`
`158`	`158`	`"id",`
`159`	`159`	`"name"`
`@@ -183,7 +183,7 @@ public void ParseStandardPetStoreDocumentShouldSucceed()`
`183`	`183`	`["newPet"] = new OpenApiSchema`
`184`	`184`	`{`
`185`	`185`	`Type = "object",`
`186`		`- Required = new List<string>`
	`186`	`+ Required = new HashSet<string>`
`187`	`187`	`{`
`188`	`188`	`"name"`
`189`	`189`	`},`
`@@ -212,7 +212,7 @@ public void ParseStandardPetStoreDocumentShouldSucceed()`
`212`	`212`	`["errorModel"] = new OpenApiSchema`
`213`	`213`	`{`
`214`	`214`	`Type = "object",`
`215`		`- Required = new List<string>`
	`215`	`+ Required = new HashSet<string>`
`216`	`216`	`{`
`217`	`217`	`"code",`
`218`	`218`	`"message"`
`@@ -580,7 +580,7 @@ public void ParseModifiedPetStoreDocumentWithTagAndSecurityShouldSucceed()`
`580`	`580`	`["pet"] = new OpenApiSchema`
`581`	`581`	`{`
`582`	`582`	`Type = "object",`
`583`		`- Required = new List<string>`
	`583`	`+ Required = new HashSet<string>`
`584`	`584`	`{`
`585`	`585`	`"id",`
`586`	`586`	`"name"`
`@@ -610,7 +610,7 @@ public void ParseModifiedPetStoreDocumentWithTagAndSecurityShouldSucceed()`
`610`	`610`	`["newPet"] = new OpenApiSchema`
`611`	`611`	`{`
`612`	`612`	`Type = "object",`
`613`		`- Required = new List<string>`
	`613`	`+ Required = new HashSet<string>`
`614`	`614`	`{`
`615`	`615`	`"name"`
`616`	`616`	`},`
`@@ -639,7 +639,7 @@ public void ParseModifiedPetStoreDocumentWithTagAndSecurityShouldSucceed()`
`639`	`639`	`["errorModel"] = new OpenApiSchema`
`640`	`640`	`{`
`641`	`641`	`Type = "object",`
`642`		`- Required = new List<string>`
	`642`	`+ Required = new HashSet<string>`
`643`	`643`	`{`
`644`	`644`	`"code",`
`645`	`645`	`"message"`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ public class OpenApiDocumentTests`
`125`	`125`	`["pet"] = new OpenApiSchema`
`126`	`126`	`{`
`127`	`127`	`Type = "object",`
`128`		`- Required = new List<string>`
	`128`	`+ Required = new HashSet<string>`
`129`	`129`	`{`
`130`	`130`	`"id",`
`131`	`131`	`"name"`
`@@ -155,7 +155,7 @@ public class OpenApiDocumentTests`
`155`	`155`	`["newPet"] = new OpenApiSchema`
`156`	`156`	`{`
`157`	`157`	`Type = "object",`
`158`		`- Required = new List<string>`
	`158`	`+ Required = new HashSet<string>`
`159`	`159`	`{`
`160`	`160`	`"name"`
`161`	`161`	`},`
`@@ -184,7 +184,7 @@ public class OpenApiDocumentTests`
`184`	`184`	`["errorModel"] = new OpenApiSchema`
`185`	`185`	`{`
`186`	`186`	`Type = "object",`
`187`		`- Required = new List<string>`
	`187`	`+ Required = new HashSet<string>`
`188`	`188`	`{`
`189`	`189`	`"code",`
`190`	`190`	`"message"`
`@@ -516,7 +516,7 @@ public class OpenApiDocumentTests`
`516`	`516`	`["pet"] = new OpenApiSchema`
`517`	`517`	`{`
`518`	`518`	`Type = "object",`
`519`		`- Required = new List<string>`
	`519`	`+ Required = new HashSet<string>`
`520`	`520`	`{`
`521`	`521`	`"id",`
`522`	`522`	`"name"`
`@@ -541,7 +541,7 @@ public class OpenApiDocumentTests`
`541`	`541`	`["newPet"] = new OpenApiSchema`
`542`	`542`	`{`
`543`	`543`	`Type = "object",`
`544`		`- Required = new List<string>`
	`544`	`+ Required = new HashSet<string>`
`545`	`545`	`{`
`546`	`546`	`"name"`
`547`	`547`	`},`
`@@ -565,7 +565,7 @@ public class OpenApiDocumentTests`
`565`	`565`	`["errorModel"] = new OpenApiSchema`
`566`	`566`	`{`
`567`	`567`	`Type = "object",`
`568`		`- Required = new List<string>`
	`568`	`+ Required = new HashSet<string>`
`569`	`569`	`{`
`570`	`570`	`"code",`
`571`	`571`	`"message"`