Merge remote-tracking branch 'origin/mk/integrate-json-schema-library' into mk/integrate-json-schema-library

MaggieKimani1 · MaggieKimani1 · commit 78b65b54f613 · 2023-11-08T12:03:48.000+03:00
diff --git a/src/Microsoft.OpenApi.Readers/SchemaTypeConverter.cs b/src/Microsoft.OpenApi.Readers/SchemaTypeConverter.cs
@@ -1,4 +1,4 @@
-﻿// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. 
 
 using System;
@@ -10,8 +10,7 @@ internal static class SchemaTypeConverter
     {
         internal static SchemaValueType ConvertToSchemaValueType(string value)
         {
-            value = value.ToLowerInvariant();
-            return value switch
+            return value.ToLowerInvariant() switch
             {
                 "string" => SchemaValueType.String,
                 "number" or "double" => SchemaValueType.Number,
diff --git a/src/Microsoft.OpenApi.Readers/V3/OpenApiParameterDeserializer.cs b/src/Microsoft.OpenApi.Readers/V3/OpenApiParameterDeserializer.cs
@@ -29,16 +29,9 @@ internal static partial class OpenApiV3Deserializer
                     {
                         var inString = n.GetScalarValue();
 
-                        if ( Enum.GetValues(typeof(ParameterLocation)).Cast<ParameterLocation>()
+                        o.In = Enum.GetValues(typeof(ParameterLocation)).Cast<ParameterLocation>()
                             .Select( e => e.GetDisplayName() )
-                            .Contains(inString) )
-                        {
-                            o.In = n.GetScalarValue().GetEnumFromDisplayName<ParameterLocation>();
-                        }
-                        else
-                        {
-                            o.In = null;
-                        }
+                            .Contains(inString) ? n.GetScalarValue().GetEnumFromDisplayName<ParameterLocation>() : null;
                     }
                 },
                 {
diff --git a/src/Microsoft.OpenApi.Readers/V31/OpenApiParameterDeserializer.cs b/src/Microsoft.OpenApi.Readers/V31/OpenApiParameterDeserializer.cs
@@ -25,17 +25,10 @@ internal static partial class OpenApiV31Deserializer
                     "in", (o, n) =>
                     {
                         var inString = n.GetScalarValue();
-
-                        if ( Enum.GetValues(typeof(ParameterLocation)).Cast<ParameterLocation>()
+                        o.In = Enum.GetValues(typeof(ParameterLocation)).Cast<ParameterLocation>()
                             .Select( e => e.GetDisplayName() )
-                            .Contains(inString) )
-                        {
-                            o.In = n.GetScalarValue().GetEnumFromDisplayName<ParameterLocation>();
-                        }
-                        else
-                        {
-                            o.In = null;
-                        }
+                            .Contains(inString) ? n.GetScalarValue().GetEnumFromDisplayName<ParameterLocation>() : null;
+
                     }
                 },
                 {
diff --git a/src/Microsoft.OpenApi.Readers/V31/OpenApiV31Deserializer.cs b/src/Microsoft.OpenApi.Readers/V31/OpenApiV31Deserializer.cs
@@ -134,14 +134,9 @@ public static OpenApiAny LoadAny(ParseNode node)
 
         private static IOpenApiExtension LoadExtension(string name, ParseNode node)
         {
-            if (node.Context.ExtensionParsers.TryGetValue(name, out var parser))
-            {
-                return parser(node.CreateAny(), OpenApiSpecVersion.OpenApi3_1);
-            }
-            else
-            {
-                return node.CreateAny();
-            }
+            return node.Context.ExtensionParsers.TryGetValue(name, out var parser)
+                ? parser(node.CreateAny(), OpenApiSpecVersion.OpenApi3_1)
+                : node.CreateAny();
         }
 
         private static string LoadString(ParseNode node)
diff --git a/src/Microsoft.OpenApi/Extensions/JsonSchemaExtensions.cs b/src/Microsoft.OpenApi/Extensions/JsonSchemaExtensions.cs
@@ -75,7 +75,7 @@ public static string GetSummary(this JsonSchema schema)
         /// <returns></returns>
         public static IDictionary<string, IOpenApiExtension> GetExtensions(this JsonSchema schema)
         {
-            return (Dictionary<string, IOpenApiExtension>)(schema.TryGetKeyword<ExtensionsKeyword>(ExtensionsKeyword.Name, out var k) ? k.Extensions! : null);
+            return schema.TryGetKeyword<ExtensionsKeyword>(ExtensionsKeyword.Name, out var k) ? k.Extensions! : null;
         }        
     }
 }
diff --git a/src/Microsoft.OpenApi/Helpers/SchemaSerializerHelper.cs b/src/Microsoft.OpenApi/Helpers/SchemaSerializerHelper.cs
@@ -1,7 +1,8 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. 
 
 using System.Collections.Generic;
+using System.Linq;
 using Json.Schema;
 using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Interfaces;
@@ -100,13 +101,10 @@ private static string RetrieveFormatFromNestedSchema(IReadOnlyCollection<JsonSch
         {
             if (schema != null)
             {
-                foreach (var item in schema)
-                {
-                    if (!string.IsNullOrEmpty(item.GetFormat()?.Key))
-                    {
-                        return item.GetFormat().Key;
-                    }
-                }
+                return schema
+                    .Where(item => !string.IsNullOrEmpty(item.GetFormat()?.Key))
+                    .Select(item => item.GetFormat().Key)
+                    .FirstOrDefault();
             }
 
             return null;
diff --git a/src/Microsoft.OpenApi/Models/OpenApiHeader.cs b/src/Microsoft.OpenApi/Models/OpenApiHeader.cs
@@ -19,6 +19,8 @@ namespace Microsoft.OpenApi.Models
     /// </summary>
     public class OpenApiHeader : IOpenApiSerializable, IOpenApiReferenceable, IOpenApiExtensible, IEffective<OpenApiHeader>
     {
+        protected JsonSchema _schema;
+
         /// <summary>
         /// Indicates if object is populated with data or is just a reference to the data
         /// </summary>
@@ -66,9 +68,13 @@ public class OpenApiHeader : IOpenApiSerializable, IOpenApiReferenceable, IOpenA
         public virtual bool AllowReserved { get; set; }
 
         /// <summary>
-        /// The schema defining the type used for the header.
+        /// The schema defining the type used for the request body.
         /// </summary>
-        public virtual JsonSchema Schema { get; set; }
+        public virtual JsonSchema Schema 
+        { 
+            get => _schema; 
+            set => _schema = value;  
+        }
 
         /// <summary>
         /// Example of the media type.
@@ -109,7 +115,7 @@ public OpenApiHeader(OpenApiHeader header)
             Style = header?.Style ?? Style;
             Explode = header?.Explode ?? Explode;
             AllowReserved = header?.AllowReserved ?? AllowReserved;
-            Schema = JsonNodeCloneHelper.CloneJsonSchema(Schema);
+            _schema = JsonNodeCloneHelper.CloneJsonSchema(header?.Schema);
             Example = JsonNodeCloneHelper.Clone(header?.Example);
             Examples = header?.Examples != null ? new Dictionary<string, OpenApiExample>(header.Examples) : null;
             Content = header?.Content != null ? new Dictionary<string, OpenApiMediaType>(header.Content) : null;
diff --git a/src/Microsoft.OpenApi/Models/OpenApiMediaType.cs b/src/Microsoft.OpenApi/Models/OpenApiMediaType.cs
@@ -17,10 +17,16 @@ namespace Microsoft.OpenApi.Models
     /// </summary>
     public class OpenApiMediaType : IOpenApiSerializable, IOpenApiExtensible
     {
+        private JsonSchema _schema;
+
         /// <summary>
         /// The schema defining the type used for the request body.
         /// </summary>
-        public virtual JsonSchema Schema { get; set; }
+        public virtual JsonSchema Schema
+        {
+            get => _schema;
+            set => _schema = value;
+        }
 
         /// <summary>
         /// Example of the media type.
@@ -57,7 +63,7 @@ public OpenApiMediaType() { }
         /// </summary>
         public OpenApiMediaType(OpenApiMediaType mediaType)
         {
-            Schema = JsonNodeCloneHelper.CloneJsonSchema(Schema);
+            _schema = JsonNodeCloneHelper.CloneJsonSchema(mediaType?.Schema);
             Example = JsonNodeCloneHelper.Clone(mediaType?.Example);
             Examples = mediaType?.Examples != null ? new Dictionary<string, OpenApiExample>(mediaType.Examples) : null;
             Encoding = mediaType?.Encoding != null ? new Dictionary<string, OpenApiEncoding>(mediaType.Encoding) : null;
diff --git a/src/Microsoft.OpenApi/Models/OpenApiParameter.cs b/src/Microsoft.OpenApi/Models/OpenApiParameter.cs
@@ -20,6 +20,7 @@ public class OpenApiParameter : IOpenApiSerializable, IOpenApiReferenceable, IEf
     {
         private bool? _explode;
         private ParameterStyle? _style;
+        protected JsonSchema _schema;
 
         /// <summary>
         /// Indicates if object is populated with data or is just a reference to the data
@@ -107,7 +108,11 @@ public virtual bool Explode
         /// <summary>
         /// The schema defining the type used for the request body.
         /// </summary>
-        public virtual JsonSchema Schema { get; set; }
+        public virtual JsonSchema Schema 
+        { 
+            get => _schema; 
+            set => _schema = value;  
+        }
 
         /// <summary>
         /// Examples of the media type. Each example SHOULD contain a value
@@ -163,7 +168,7 @@ public OpenApiParameter(OpenApiParameter parameter)
             Style = parameter?.Style ?? Style;
             Explode = parameter?.Explode ?? Explode;
             AllowReserved = parameter?.AllowReserved ?? AllowReserved;
-            Schema = JsonNodeCloneHelper.CloneJsonSchema(Schema);
+            _schema = JsonNodeCloneHelper.CloneJsonSchema(parameter?.Schema);
             Examples = parameter?.Examples != null ? new Dictionary<string, OpenApiExample>(parameter.Examples) : null;
             Example = JsonNodeCloneHelper.Clone(parameter?.Example);
             Content = parameter?.Content != null ? new Dictionary<string, OpenApiMediaType>(parameter.Content) : null;
diff --git a/src/Microsoft.OpenApi/Models/References/OpenApiHeaderReference.cs b/src/Microsoft.OpenApi/Models/References/OpenApiHeaderReference.cs
@@ -73,7 +73,7 @@ public override string Description
         public override bool AllowEmptyValue { get => Target.AllowEmptyValue; set => Target.AllowEmptyValue = value; }
 
         /// <inheritdoc/>
-        public override JsonSchema Schema { get => Target.Schema; set => Target.Schema = value; }
+        public override JsonSchema Schema { get => _schema; set => _schema = value; }
 
         /// <inheritdoc/>
         public override ParameterStyle? Style { get => Target.Style; set => Target.Style = value; }
diff --git a/src/Microsoft.OpenApi/Models/References/OpenApiParameterReference.cs b/src/Microsoft.OpenApi/Models/References/OpenApiParameterReference.cs
@@ -84,7 +84,7 @@ public override string Description
         public override bool AllowReserved { get => Target.AllowReserved; set => Target.AllowReserved = value; }
 
         /// <inheritdoc/>
-        public override JsonSchema Schema { get => Target.Schema; set => Target.Schema = value; }
+        public override JsonSchema Schema { get => _schema; set => _schema = value; }
 
         /// <inheritdoc/>
         public override IDictionary<string, OpenApiExample> Examples { get => Target.Examples; set => Target.Examples = value; }
diff --git a/src/Microsoft.OpenApi/Writers/OpenApiJsonWriter.cs b/src/Microsoft.OpenApi/Writers/OpenApiJsonWriter.cs
@@ -1,17 +1,7 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license. 
 
-using System;
-using System.Collections.Generic;
 using System.IO;
-using System.Linq;
-using System.Text;
-using System.Text.Json;
-using Json.Schema;
-using Json.Schema.OpenApi;
-using Microsoft.OpenApi.Any;
-using Microsoft.OpenApi.Extensions;
-using Microsoft.OpenApi.Models;
 
 namespace Microsoft.OpenApi.Writers
 {
diff --git a/src/Microsoft.OpenApi/Writers/OpenApiYamlWriter.cs b/src/Microsoft.OpenApi/Writers/OpenApiYamlWriter.cs
@@ -2,15 +2,6 @@
 // Licensed under the MIT license. 
 
 using System.IO;
-using System.Text.Json.Nodes;
-using System.Text.Json;
-using Json.Schema;
-using Microsoft.OpenApi.Models;
-using YamlDotNet.Serialization;
-using System.Collections.Generic;
-using Yaml2JsonNode;
-using System.Collections;
-using System;
 
 namespace Microsoft.OpenApi.Writers
 {
@@ -231,7 +222,6 @@ public override void WriteValue(string value)
             }
         }
 
-
         private void WriteChompingIndicator(string value)
         {
             var trailingNewlines = 0;
diff --git a/test/Microsoft.OpenApi.Tests/Models/OpenApiDocumentTests.cs b/test/Microsoft.OpenApi.Tests/Models/OpenApiDocumentTests.cs
@@ -25,7 +25,7 @@ namespace Microsoft.OpenApi.Tests.Models
     [UsesVerify]
     public class OpenApiDocumentTests
     {
-        public static OpenApiComponents TopLevelReferencingComponents = new OpenApiComponents()
+        public static readonly OpenApiComponents TopLevelReferencingComponents = new OpenApiComponents()
         {
             Schemas =
             {
@@ -37,7 +37,7 @@ public class OpenApiDocumentTests
             }
         };
 
-        public static OpenApiComponents TopLevelSelfReferencingComponentsWithOtherProperties = new OpenApiComponents()
+        public static readonly OpenApiComponents TopLevelSelfReferencingComponentsWithOtherProperties = new OpenApiComponents()
         {
             Schemas =
             {
@@ -52,15 +52,15 @@ public class OpenApiDocumentTests
 
         };
 
-        public static OpenApiComponents TopLevelSelfReferencingComponents = new OpenApiComponents()
+        public static readonly OpenApiComponents TopLevelSelfReferencingComponents = new OpenApiComponents()
         {
             Schemas =
             {
                 ["schema1"] = new JsonSchemaBuilder().Ref("#/definitions/schemas/schema1")
             }
         };
 
-        public static OpenApiDocument SimpleDocumentWithTopLevelReferencingComponents = new OpenApiDocument()
+        public static readonly OpenApiDocument SimpleDocumentWithTopLevelReferencingComponents = new OpenApiDocument()
         {
             Info = new OpenApiInfo()
             {
@@ -69,7 +69,7 @@ public class OpenApiDocumentTests
             Components = TopLevelReferencingComponents
         };
 
-        public static OpenApiDocument SimpleDocumentWithTopLevelSelfReferencingComponentsWithOtherProperties = new OpenApiDocument()
+        public static readonly OpenApiDocument SimpleDocumentWithTopLevelSelfReferencingComponentsWithOtherProperties = new OpenApiDocument()
         {
             Info = new OpenApiInfo()
             {
@@ -78,7 +78,7 @@ public class OpenApiDocumentTests
             Components = TopLevelSelfReferencingComponentsWithOtherProperties
         };
 
-        public static OpenApiDocument SimpleDocumentWithTopLevelSelfReferencingComponents = new OpenApiDocument()
+        public static readonly OpenApiDocument SimpleDocumentWithTopLevelSelfReferencingComponents = new OpenApiDocument()
         {
             Info = new OpenApiInfo()
             {
@@ -87,7 +87,7 @@ public class OpenApiDocumentTests
             Components = TopLevelSelfReferencingComponents
         };
 
-        public static OpenApiComponents AdvancedComponentsWithReference = new OpenApiComponents
+        public static readonly OpenApiComponents AdvancedComponentsWithReference = new OpenApiComponents
         {
             Schemas = new Dictionary<string, JsonSchema>
             {
@@ -116,14 +116,14 @@ public class OpenApiDocumentTests
             }
         };
 
-        public static JsonSchema PetSchemaWithReference = AdvancedComponentsWithReference.Schemas["pet"];
+        public static readonly JsonSchema PetSchemaWithReference = AdvancedComponentsWithReference.Schemas["pet"];
 
-        public static JsonSchema NewPetSchemaWithReference = AdvancedComponentsWithReference.Schemas["newPet"];
+        public static readonly JsonSchema NewPetSchemaWithReference = AdvancedComponentsWithReference.Schemas["newPet"];
 
-        public static JsonSchema ErrorModelSchemaWithReference =
+        public static readonly JsonSchema ErrorModelSchemaWithReference =
             AdvancedComponentsWithReference.Schemas["errorModel"];
 
-        public static OpenApiDocument AdvancedDocumentWithReference = new OpenApiDocument
+        public static readonly OpenApiDocument AdvancedDocumentWithReference = new OpenApiDocument
         {
             Info = new OpenApiInfo
             {
@@ -402,7 +402,7 @@ public class OpenApiDocumentTests
             Components = AdvancedComponentsWithReference
         };
 
-        public static OpenApiComponents AdvancedComponents = new OpenApiComponents
+        public static readonly OpenApiComponents AdvancedComponents = new OpenApiComponents
         {
             Schemas = new Dictionary<string, JsonSchema>
             {
@@ -428,11 +428,11 @@ public class OpenApiDocumentTests
             }
         };
 
-        public static JsonSchema PetSchema = AdvancedComponents.Schemas["pet"];
+        public static readonly JsonSchema PetSchema = AdvancedComponents.Schemas["pet"];
 
-        public static JsonSchema NewPetSchema = AdvancedComponents.Schemas["newPet"];
+        public static readonly JsonSchema NewPetSchema = AdvancedComponents.Schemas["newPet"];
 
-        public static JsonSchema ErrorModelSchema = AdvancedComponents.Schemas["errorModel"];
+        public static readonly JsonSchema ErrorModelSchema = AdvancedComponents.Schemas["errorModel"];
 
         public OpenApiDocument AdvancedDocument = new OpenApiDocument
         {
@@ -719,7 +719,7 @@ public class OpenApiDocumentTests
             Components = AdvancedComponents
         };
 
-        public static OpenApiDocument DocumentWithWebhooks = new OpenApiDocument()
+        public static readonly OpenApiDocument DocumentWithWebhooks = new OpenApiDocument()
         {
             Info = new OpenApiInfo
             {
@@ -773,7 +773,7 @@ public class OpenApiDocumentTests
             }
         };
 
-        public static OpenApiDocument DuplicateExtensions = new OpenApiDocument
+        public static readonly OpenApiDocument DuplicateExtensions = new OpenApiDocument
         {
             Info = new OpenApiInfo
             {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright (c) Microsoft Corporation. All rights reserved.`
	`1`	`+// Copyright (c) Microsoft Corporation. All rights reserved.`
`2`	`2`	`// Licensed under the MIT license.`
`3`	`3`
`4`	`4`	`using System;`
`@@ -10,8 +10,7 @@ internal static class SchemaTypeConverter`
`10`	`10`	`{`
`11`	`11`	`internal static SchemaValueType ConvertToSchemaValueType(string value)`
`12`	`12`	`{`
`13`		`- value = value.ToLowerInvariant();`
`14`		`- return value switch`
	`13`	`+ return value.ToLowerInvariant() switch`
`15`	`14`	`{`
`16`	`15`	`"string" => SchemaValueType.String,`
`17`	`16`	`"number" or "double" => SchemaValueType.Number,`
Original file line number	Diff line number	Diff line change
`@@ -29,16 +29,9 @@ internal static partial class OpenApiV3Deserializer`
`29`	`29`	`{`
`30`	`30`	`var inString = n.GetScalarValue();`
`31`	`31`
`32`		`- if ( Enum.GetValues(typeof(ParameterLocation)).Cast<ParameterLocation>()`
	`32`	`+ o.In = Enum.GetValues(typeof(ParameterLocation)).Cast<ParameterLocation>()`
`33`	`33`	`.Select( e => e.GetDisplayName() )`
`34`		`- .Contains(inString) )`
`35`		`- {`
`36`		`- o.In = n.GetScalarValue().GetEnumFromDisplayName<ParameterLocation>();`
`37`		`- }`
`38`		`- else`
`39`		`- {`
`40`		`- o.In = null;`
`41`		`- }`
	`34`	`+ .Contains(inString) ? n.GetScalarValue().GetEnumFromDisplayName<ParameterLocation>() : null;`
`42`	`35`	`}`
`43`	`36`	`},`
`44`	`37`	`{`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ public static string GetSummary(this JsonSchema schema)`
`75`	`75`	`/// <returns></returns>`
`76`	`76`	`public static IDictionary<string, IOpenApiExtension> GetExtensions(this JsonSchema schema)`
`77`	`77`	`{`
`78`		`- return (Dictionary<string, IOpenApiExtension>)(schema.TryGetKeyword<ExtensionsKeyword>(ExtensionsKeyword.Name, out var k) ? k.Extensions! : null);`
	`78`	`+ return schema.TryGetKeyword<ExtensionsKeyword>(ExtensionsKeyword.Name, out var k) ? k.Extensions! : null;`
`79`	`79`	`}`
`80`	`80`	`}`
`81`	`81`	`}`