Clean up code and update API interface

Author: MaggieKimani1

src/Microsoft.OpenApi/Extensions/JsonSchemaBuilderExtensions.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;
@@ -112,25 +112,6 @@ public static JsonSchemaBuilder OpenApiExternalDocs(this JsonSchemaBuilder build
             return builder;
         }
 
-        /// <summary>
-        /// Removes a keyword from the builder instance
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="keyWord"></param>
-        /// <returns></returns>
-        public static JsonSchemaBuilder RemoveKeyWord(this JsonSchemaBuilder builder, IJsonSchemaKeyword keyWord)
-        {
-            var schema = builder.Build();
-            var newKeyWords = new List<IJsonSchemaKeyword>();
-            newKeyWords = schema.Keywords.Where(x => !x.Equals(keyWord)).ToList();
-            foreach (var item in newKeyWords)
-            {
-                builder.Add(item);
-            }
-
-            return builder;
-        }
-
         /// <summary>
         /// Removes a keyword
         /// </summary>
@@ -153,7 +134,6 @@ public static JsonSchemaBuilder Remove(this JsonSchemaBuilder builder, string ke
                 }
             }
 
-            //_keywords.Remove(keyword);
             return schemaBuilder;
         }
     }

src/Microsoft.OpenApi/Models/OpenApiRequestBody.cs

@@ -185,7 +185,7 @@ internal OpenApiBodyParameter ConvertToBodyParameter()
                 // V2 spec actually allows the body to have custom name.
                 // To allow round-tripping we use an extension to hold the name
                 Name = "body",
-                Schema = Content.Values.FirstOrDefault()?.Schema ?? new OpenApiSchema(),
+                Schema = Content.Values.FirstOrDefault()?.Schema ?? new JsonSchemaBuilder(),
                 Required = Required,
                 Extensions = Extensions.ToDictionary(static k => k.Key, static v => v.Value)  // Clone extensions so we can remove the x-bodyName extensions from the output V2 model.
             };
@@ -219,7 +219,7 @@ internal IEnumerable<OpenApiFormDataParameter> ConvertToFormDataParameters()
                     Description = property.Value.GetDescription(),
                     Name = property.Key,
                     Schema = property.Value,
-                    Required = Content.First().Value.Schema.Required.Contains(property.Key)
+                    Required = Content.First().Value.Schema.GetRequired().Contains(property.Key)
                 };
             }
         }

test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

@@ -166,6 +166,14 @@ namespace Microsoft.OpenApi.Extensions
         public const string Name = "extensions";
         public void Evaluate(Json.Schema.EvaluationContext context) { }
     }
+    [Json.Schema.SchemaKeyword("externalDocs")]
+    public class ExternalDocsKeyword : Json.Schema.IJsonSchemaKeyword
+    {
+        public const string Name = "externalDocs";
+        public ExternalDocsKeyword(Microsoft.OpenApi.Models.OpenApiExternalDocs value) { }
+        public Microsoft.OpenApi.Models.OpenApiExternalDocs Value { get; }
+        public void Evaluate(Json.Schema.EvaluationContext context) { }
+    }
     public static class JsonSchemaBuilderExtensions
     {
         public static Json.Schema.JsonSchemaBuilder AdditionalPropertiesAllowed(this Json.Schema.JsonSchemaBuilder builder, bool additionalPropertiesAllowed) { }
@@ -174,6 +182,8 @@ namespace Microsoft.OpenApi.Extensions
         public static Json.Schema.JsonSchemaBuilder ExclusiveMinimum(this Json.Schema.JsonSchemaBuilder builder, bool value) { }
         public static Json.Schema.JsonSchemaBuilder Extensions(this Json.Schema.JsonSchemaBuilder builder, System.Collections.Generic.IDictionary<string, Microsoft.OpenApi.Interfaces.IOpenApiExtension> extensions) { }
         public static Json.Schema.JsonSchemaBuilder Nullable(this Json.Schema.JsonSchemaBuilder builder, bool value) { }
+        public static Json.Schema.JsonSchemaBuilder OpenApiExternalDocs(this Json.Schema.JsonSchemaBuilder builder, Microsoft.OpenApi.Models.OpenApiExternalDocs externalDocs) { }
+        public static Json.Schema.JsonSchemaBuilder Remove(this Json.Schema.JsonSchemaBuilder builder, string keyword) { }
         public static Json.Schema.JsonSchemaBuilder Summary(this Json.Schema.JsonSchemaBuilder builder, string summary) { }
     }
     public static class JsonSchemaExtensions
@@ -184,6 +194,7 @@ namespace Microsoft.OpenApi.Extensions
         public static Microsoft.OpenApi.Extensions.DiscriminatorKeyword GetOpenApiDiscriminator(this Json.Schema.JsonSchema schema) { }
         public static bool? GetOpenApiExclusiveMaximum(this Json.Schema.JsonSchema schema) { }
         public static bool? GetOpenApiExclusiveMinimum(this Json.Schema.JsonSchema schema) { }
+        public static Microsoft.OpenApi.Models.OpenApiExternalDocs GetOpenApiExternalDocs(this Json.Schema.JsonSchema schema) { }
         public static string GetSummary(this Json.Schema.JsonSchema schema) { }
     }
     [Json.Schema.SchemaKeyword("nullable")]
@@ -299,7 +310,7 @@ namespace Microsoft.OpenApi.MicrosoftExtensions
     public class EnumDescription : Microsoft.OpenApi.Interfaces.IOpenApiElement
     {
         public EnumDescription() { }
-        public EnumDescription(Microsoft.OpenApi.Any.OpenApiObject source) { }
+        public EnumDescription(System.Text.Json.Nodes.JsonObject source) { }
         public string Description { get; set; }
         public string Name { get; set; }
         public string Value { get; set; }
@@ -313,15 +324,15 @@ namespace Microsoft.OpenApi.MicrosoftExtensions
         public string Version { get; set; }
         public static string Name { get; }
         public void Write(Microsoft.OpenApi.Writers.IOpenApiWriter writer, Microsoft.OpenApi.OpenApiSpecVersion specVersion) { }
-        public static Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension Parse(Microsoft.OpenApi.Any.IOpenApiAny source) { }
+        public static Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension Parse(Microsoft.OpenApi.Any.OpenApiAny source) { }
     }
     public class OpenApiEnumFlagsExtension : Microsoft.OpenApi.Interfaces.IOpenApiExtension
     {
         public OpenApiEnumFlagsExtension() { }
         public bool IsFlags { get; set; }
         public static string Name { get; }
         public void Write(Microsoft.OpenApi.Writers.IOpenApiWriter writer, Microsoft.OpenApi.OpenApiSpecVersion specVersion) { }
-        public static Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumFlagsExtension Parse(Microsoft.OpenApi.Any.IOpenApiAny source) { }
+        public static Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumFlagsExtension Parse(Microsoft.OpenApi.Any.OpenApiAny source) { }
     }
     public class OpenApiEnumValuesDescriptionExtension : Microsoft.OpenApi.Interfaces.IOpenApiExtension
     {
@@ -330,7 +341,7 @@ namespace Microsoft.OpenApi.MicrosoftExtensions
         public System.Collections.Generic.List<Microsoft.OpenApi.MicrosoftExtensions.EnumDescription> ValuesDescriptions { get; set; }
         public static string Name { get; }
         public void Write(Microsoft.OpenApi.Writers.IOpenApiWriter writer, Microsoft.OpenApi.OpenApiSpecVersion specVersion) { }
-        public static Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumValuesDescriptionExtension Parse(Microsoft.OpenApi.Any.IOpenApiAny source) { }
+        public static Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumValuesDescriptionExtension Parse(Microsoft.OpenApi.Any.OpenApiAny source) { }
     }
     public class OpenApiPagingExtension : Microsoft.OpenApi.Interfaces.IOpenApiExtension
     {
@@ -340,23 +351,23 @@ namespace Microsoft.OpenApi.MicrosoftExtensions
         public string OperationName { get; set; }
         public static string Name { get; }
         public void Write(Microsoft.OpenApi.Writers.IOpenApiWriter writer, Microsoft.OpenApi.OpenApiSpecVersion specVersion) { }
-        public static Microsoft.OpenApi.MicrosoftExtensions.OpenApiPagingExtension Parse(Microsoft.OpenApi.Any.IOpenApiAny source) { }
+        public static Microsoft.OpenApi.MicrosoftExtensions.OpenApiPagingExtension Parse(Microsoft.OpenApi.Any.OpenApiAny source) { }
     }
     public class OpenApiPrimaryErrorMessageExtension : Microsoft.OpenApi.Interfaces.IOpenApiExtension
     {
         public OpenApiPrimaryErrorMessageExtension() { }
         public bool IsPrimaryErrorMessage { get; set; }
         public static string Name { get; }
         public void Write(Microsoft.OpenApi.Writers.IOpenApiWriter writer, Microsoft.OpenApi.OpenApiSpecVersion specVersion) { }
-        public static Microsoft.OpenApi.MicrosoftExtensions.OpenApiPrimaryErrorMessageExtension Parse(Microsoft.OpenApi.Any.IOpenApiAny source) { }
+        public static Microsoft.OpenApi.MicrosoftExtensions.OpenApiPrimaryErrorMessageExtension Parse(Microsoft.OpenApi.Any.OpenApiAny source) { }
     }
     public class OpenApiReservedParameterExtension : Microsoft.OpenApi.Interfaces.IOpenApiExtension
     {
         public OpenApiReservedParameterExtension() { }
         public bool? IsReserved { get; set; }
         public static string Name { get; }
         public void Write(Microsoft.OpenApi.Writers.IOpenApiWriter writer, Microsoft.OpenApi.OpenApiSpecVersion specVersion) { }
-        public static Microsoft.OpenApi.MicrosoftExtensions.OpenApiReservedParameterExtension Parse(Microsoft.OpenApi.Any.IOpenApiAny source) { }
+        public static Microsoft.OpenApi.MicrosoftExtensions.OpenApiReservedParameterExtension Parse(Microsoft.OpenApi.Any.OpenApiAny source) { }
     }
 }
 namespace Microsoft.OpenApi.Models
@@ -1542,6 +1553,7 @@ namespace Microsoft.OpenApi.Writers
         public abstract void WriteRaw(string value);
         public abstract void WriteStartArray();
         public abstract void WriteStartObject();
+        public void WriteV2Examples(Microsoft.OpenApi.Writers.IOpenApiWriter writer, Microsoft.OpenApi.Models.OpenApiExample example, Microsoft.OpenApi.OpenApiSpecVersion version) { }
         public virtual void WriteValue(bool value) { }
         public virtual void WriteValue(System.DateTime value) { }
         public virtual void WriteValue(System.DateTimeOffset value) { }
@@ -1572,6 +1584,8 @@ namespace Microsoft.OpenApi.Writers
             where T :  struct { }
         public static void WriteProperty<T>(this Microsoft.OpenApi.Writers.IOpenApiWriter writer, string name, T? value)
             where T :  struct { }
+        public static void WriteRequiredCollection<T>(this Microsoft.OpenApi.Writers.IOpenApiWriter writer, string name, System.Collections.Generic.IEnumerable<T> elements, System.Action<Microsoft.OpenApi.Writers.IOpenApiWriter, T> action)
+            where T : Microsoft.OpenApi.Interfaces.IOpenApiElement { }
         public static void WriteRequiredMap(this Microsoft.OpenApi.Writers.IOpenApiWriter writer, string name, System.Collections.Generic.IDictionary<string, string> elements, System.Action<Microsoft.OpenApi.Writers.IOpenApiWriter, string> action) { }
         public static void WriteRequiredMap<T>(this Microsoft.OpenApi.Writers.IOpenApiWriter writer, string name, System.Collections.Generic.IDictionary<string, T> elements, System.Action<Microsoft.OpenApi.Writers.IOpenApiWriter, T> action)
             where T : Microsoft.OpenApi.Interfaces.IOpenApiElement { }

test/Microsoft.OpenApi.Tests/Validations/ValidationRuleSetTests.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.Collections.Generic;
@@ -52,8 +52,8 @@ public void RuleSetConstructorsReturnsTheCorrectRules()
             Assert.Empty(ruleSet_4.Rules);
 
             // Update the number if you add new default rule(s).
-            Assert.Equal(22, ruleSet_1.Rules.Count);
-            Assert.Equal(22, ruleSet_2.Rules.Count);
+            Assert.Equal(23, ruleSet_1.Rules.Count);
+            Assert.Equal(23, ruleSet_2.Rules.Count);
             Assert.Equal(3, ruleSet_3.Rules.Count);
         }