Merge remote-tracking branch 'origin/vnext' into mk/add-filter-by-tags

Author: MaggieKimani1

src/Microsoft.OpenApi.Tool/OpenApiService.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;
@@ -28,22 +28,28 @@ public static void ProcessOpenApiDocument(
             bool inline,
             bool resolveExternal)
         {
-            if (input == null)
+            if (string.IsNullOrEmpty(input))
             {
-                throw new ArgumentNullException("input");
+                throw new ArgumentNullException(nameof(input));
+            }
+            if(output == null)
+            {
+                throw new ArgumentException(nameof(output));
+            }
+            if (output.Exists)
+            {
+                throw new IOException("The file you're writing to already exists. Please input a new output path.");
             }
 
             var stream = GetStream(input);
-
-            OpenApiDocument document;
-
             var result = new OpenApiStreamReader(new OpenApiReaderSettings
             {
                 ReferenceResolution = resolveExternal ? ReferenceResolutionSetting.ResolveAllReferences : ReferenceResolutionSetting.ResolveLocalReferences,
                 RuleSet = ValidationRuleSet.GetDefaultRuleSet()
             }
             ).ReadAsync(stream).GetAwaiter().GetResult();
 
+            OpenApiDocument document;
             document = result.OpenApiDocument;
 
             // Check if filter options are provided, then execute
@@ -65,7 +71,7 @@ public static void ProcessOpenApiDocument(
 
             var context = result.OpenApiDiagnostic;
 
-            if (context.Errors.Count != 0)
+            if (context.Errors.Count > 0)
             {
                 var errorReport = new StringBuilder();
 
@@ -77,11 +83,6 @@ public static void ProcessOpenApiDocument(
                 throw new ArgumentException(string.Join(Environment.NewLine, context.Errors.Select(e => e.Message).ToArray()));
             }
 
-            if (output.Exists)
-            {
-                throw new IOException("The file you're writing to already exists.Please input a new output path.");
-            }
-
             using var outputStream = output?.Create();
 
             var textWriter = outputStream != null ? new StreamWriter(outputStream) : Console.Out;
@@ -137,7 +138,6 @@ internal static void ValidateOpenApiDocument(string input)
 
             document = new OpenApiStreamReader(new OpenApiReaderSettings
             {
-                //ReferenceResolution = resolveExternal == true ? ReferenceResolutionSetting.ResolveAllReferences : ReferenceResolutionSetting.ResolveLocalReferences,
                 RuleSet = ValidationRuleSet.GetDefaultRuleSet()
             }
             ).Read(stream, out var context);

src/Microsoft.OpenApi/Services/CopyReferences.cs

@@ -1,19 +1,26 @@
-using System.Collections.Generic;
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
+
+using System.Collections.Generic;
 using Microsoft.OpenApi.Interfaces;
 using Microsoft.OpenApi.Models;
 
 namespace Microsoft.OpenApi.Services
 {
     internal class CopyReferences : OpenApiVisitorBase
     {
-        private readonly OpenApiDocument target;
-        public OpenApiComponents Components = new OpenApiComponents();
+        private readonly OpenApiDocument _target;
+        public OpenApiComponents Components = new();
 
         public CopyReferences(OpenApiDocument target)
         {
-            this.target = target;
+            _target = target;
         }
 
+        /// <summary>
+        /// Visits IOpenApiReferenceable instances that are references and not in components.
+        /// </summary>
+        /// <param name="referenceable"> An IOpenApiReferenceable object.</param>
         public override void Visit(IOpenApiReferenceable referenceable)
         {
             switch (referenceable)
@@ -51,6 +58,10 @@ public override void Visit(IOpenApiReferenceable referenceable)
             base.Visit(referenceable);
         }
 
+        /// <summary>
+        /// Visits <see cref="OpenApiSchema"/>
+        /// </summary>
+        /// <param name="schema">The OpenApiSchema to be visited.</param>
         public override void Visit(OpenApiSchema schema)
         {
             // This is needed to handle schemas used in Responses in components
@@ -68,33 +79,33 @@ public override void Visit(OpenApiSchema schema)
 
         private void EnsureComponentsExists()
         {
-            if (target.Components == null)
+            if (_target.Components == null)
             {
-                target.Components = new OpenApiComponents();
+                _target.Components = new OpenApiComponents();
             }
         }
 
         private void EnsureSchemasExists()
         {
-            if (target.Components.Schemas == null)
+            if (_target.Components.Schemas == null)
             {
-                target.Components.Schemas = new Dictionary<string, OpenApiSchema>();
+                _target.Components.Schemas = new Dictionary<string, OpenApiSchema>();
             }
         }
 
         private void EnsureParametersExists()
         {
-            if (target.Components.Parameters == null)
+            if (_target.Components.Parameters == null)
             {
-                target.Components.Parameters = new Dictionary<string, OpenApiParameter>();
+                _target.Components.Parameters = new Dictionary<string, OpenApiParameter>();
             }
         }
 
         private void EnsureResponsesExists()
         {
-            if (target.Components.Responses == null)
+            if (_target.Components.Responses == null)
             {
-                target.Components.Responses = new Dictionary<string, OpenApiResponse>();
+                _target.Components.Responses = new Dictionary<string, OpenApiResponse>();
             }
         }
     }

src/Microsoft.OpenApi/Services/OpenApiFilterService.cs

@@ -22,8 +22,6 @@ public static class OpenApiFilterService
         /// <returns>A predicate.</returns>
         public static Func<OpenApiOperation, bool> CreatePredicate(string operationIds = null, string tags = null)
         {
-            string predicateSource = null;
-
             Func<OpenApiOperation, bool> predicate;
             if (operationIds != null)
             {
@@ -36,8 +34,6 @@ public static Func<OpenApiOperation, bool> CreatePredicate(string operationIds =
                     var operationIdsArray = operationIds.Split(',');
                     predicate = (o) => operationIdsArray.Contains(o.OperationId);
                 }
-
-                predicateSource = $"operationIds: {operationIds}";
             }
             else if (tags != null)
             {
@@ -77,8 +73,13 @@ public static OpenApiDocument CreateFilteredDocument(OpenApiDocument source, Fun
             {
                 Info = new OpenApiInfo()
                 {
-                    Title = source.Info.Title + " - subset",
-                    Version = source.Info.Version
+                    Title = source.Info.Title + " - Subset",
+                    Description = source.Info.Description,
+                    TermsOfService = source.Info.TermsOfService,
+                    Contact = source.Info.Contact,
+                    License = source.Info.License,
+                    Version = source.Info.Version,
+                    Extensions = source.Info.Extensions
                 },
 
                 Components = new OpenApiComponents()
@@ -92,7 +93,7 @@ public static OpenApiDocument CreateFilteredDocument(OpenApiDocument source, Fun
             foreach (var result in results)
             {
                 OpenApiPathItem pathItem;
-                string pathKey = result.CurrentKeys.Path;
+                var pathKey = result.CurrentKeys.Path;
 
                 if (subset.Paths == null)
                 {

src/Microsoft.OpenApi/Services/OperationSearch.cs

@@ -8,13 +8,23 @@
 
 namespace Microsoft.OpenApi.Services
 {
+    /// <summary>
+    /// Visits OpenApi operations and parameters.
+    /// </summary>
     public class OperationSearch : OpenApiVisitorBase
     {
         private readonly Func<OpenApiOperation, bool> _predicate;
         private readonly List<SearchResult> _searchResults = new();
 
+        /// <summary>
+        /// A list of operations from the operation search.
+        /// </summary>
         public IList<SearchResult> SearchResults => _searchResults;
 
+        /// <summary>
+        /// The OperationSearch constructor.
+        /// </summary>
+        /// <param name="predicate">A predicate function.</param>
         public OperationSearch(Func<OpenApiOperation, bool> predicate)
         {
             _predicate = predicate ?? throw new ArgumentNullException(nameof(predicate));

src/Microsoft.OpenApi/Services/SearchResult.cs

@@ -5,9 +5,19 @@
 
 namespace Microsoft.OpenApi.Services
 {
+    /// <summary>
+    /// Defines a search result model for visited operations.
+    /// </summary>
     public class SearchResult
     {
+        /// <summary>
+        /// An object containing contextual information based on where the walker is currently referencing in an OpenApiDocument.
+        /// </summary>
         public CurrentKeys CurrentKeys { get; set; }
+
+        /// <summary>
+        /// An Operation object.
+        /// </summary>
         public OpenApiOperation Operation { get; set; }
     }
 }

test/Microsoft.OpenApi.Tests/Validations/OpenApiParameterValidationTests.cs

@@ -218,7 +218,7 @@ public void PathParameterNotInThePathShouldReturnAnError()
         }
 
         [Fact]
-        public void PathParameterInThePastShouldBeOk()
+        public void PathParameterInThePathShouldBeOk()
         {
             // Arrange
             IEnumerable<OpenApiError> errors;

test/Microsoft.OpenApi.Tests/Workspaces/OpenApiWorkspaceTests.cs

@@ -1,5 +1,5 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT license. 
+// Licensed under the MIT license.
 
 using System;
 using System.Collections.Generic;
@@ -12,7 +12,7 @@
 
 namespace Microsoft.OpenApi.Tests
 {
-    
+
     public class OpenApiWorkspaceTests
     {
         [Fact]
@@ -61,7 +61,7 @@ public void OpenApiWorkspacesAllowDocumentsToReferenceEachOther()
                                 }
                             }
                         }
-                    } 
+                    }
                 }
             });
             workspace.AddDocument("common", new OpenApiDocument() {
@@ -111,7 +111,7 @@ public void OpenApiWorkspacesAllowDocumentsToReferenceEachOther_short()
                       re.CreateContent("application/json", co =>
                           co.Schema = new OpenApiSchema()
                           {
-                              Reference = new OpenApiReference()  // Reference 
+                              Reference = new OpenApiReference()  // Reference
                               {
                                   Id = "test",
                                   Type = ReferenceType.Schema,