Merge pull request #943 from microsoft/mk/fix-missing-path-params

MaggieKimani1 · web-flow · commit 9dc6ef1d82cb · 2022-07-18T11:43:11.000+03:00
Fixes missing path parameters
diff --git a/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiFilterServiceTests.cs b/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiFilterServiceTests.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;
@@ -135,5 +135,22 @@ public void ThrowsInvalidOperationExceptionInCreatePredicateWhenInvalidArguments
             var message2 = Assert.Throws<InvalidOperationException>(() => OpenApiFilterService.CreatePredicate("users.user.ListUser", "users.user")).Message;
             Assert.Equal("Cannot specify both operationIds and tags at the same time.", message2);
         }
+
+        [Theory]
+        [InlineData("reports.getTeamsUserActivityUserDetail-a3f1", null)]
+        [InlineData(null, "reports.Functions")]
+        public void ReturnsPathParametersOnSlicingBasedOnOperationIdsOrTags(string operationIds, string tags)
+        {
+            // Act
+            var predicate = OpenApiFilterService.CreatePredicate(operationIds, tags);
+            var subsetOpenApiDocument = OpenApiFilterService.CreateFilteredDocument(_openApiDocumentMock, predicate);
+
+            // Assert
+            foreach (var pathItem in subsetOpenApiDocument.Paths)
+            {
+                Assert.True(pathItem.Value.Parameters.Any());
+                Assert.Equal(1, pathItem.Value.Parameters.Count);
+            }
+        }
     }
 }
diff --git a/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/OpenApiDocumentMock.cs b/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/OpenApiDocumentMock.cs
@@ -116,6 +116,21 @@ public static OpenApiDocument CreateOpenApiDocument()
                                     }
                                 }
                             }
+                        },
+                        Parameters = new List<OpenApiParameter>
+                        {
+                            {
+                                new OpenApiParameter()
+                                {
+                                    Name = "period",
+                                    In = ParameterLocation.Path,
+                                    Required = true,
+                                    Schema = new OpenApiSchema()
+                                    {
+                                        Type = "string"
+                                    }
+                                }
+                            }
                         }
                     },
                     ["/reports/microsoft.graph.getTeamsUserActivityUserDetail(date={date})"] = new OpenApiPathItem()
@@ -175,7 +190,20 @@ public static OpenApiDocument CreateOpenApiDocument()
                                     }
                                 }
                             }
-                        }
+                        },
+                        Parameters = new List<OpenApiParameter>
+                        {
+                            new OpenApiParameter
+                            {
+                                Name = "period",
+                                In = ParameterLocation.Path,
+                                Required = true,
+                                Schema = new OpenApiSchema()
+                                {
+                                    Type = "string"
+                                }
+                            }
+                        }                                    
                     },
                     ["/users"] = new OpenApiPathItem()
                     {
diff --git a/src/Microsoft.OpenApi/Services/OpenApiFilterService.cs b/src/Microsoft.OpenApi/Services/OpenApiFilterService.cs
@@ -164,6 +164,14 @@ public static OpenApiDocument CreateFilteredDocument(OpenApiDocument source, Fun
                 if (result.CurrentKeys.Operation != null)
                 {
                     pathItem.Operations.Add((OperationType)result.CurrentKeys.Operation, result.Operation);
+
+                    if (result.Parameters?.Any() ?? false)
+                    {
+                        foreach (var parameter in result.Parameters)
+                        {
+                            pathItem.Parameters.Add(parameter);
+                        }
+                    }
                 }
             }
 
diff --git a/src/Microsoft.OpenApi/Services/OperationSearch.cs b/src/Microsoft.OpenApi/Services/OperationSearch.cs
@@ -31,18 +31,25 @@ public OperationSearch(Func<string, OperationType?,OpenApiOperation, bool> predi
         }
 
         /// <summary>
-        /// Visits <see cref="OpenApiOperation"/>.
+        /// Visits <see cref="OpenApiPathItem"/>
         /// </summary>
-        /// <param name="operation">The target <see cref="OpenApiOperation"/>.</param>
-        public override void Visit(OpenApiOperation operation)
+        /// <param name="pathItem"> The target <see cref="OpenApiPathItem"/>.</param>
+        public override void Visit(OpenApiPathItem pathItem)
         {
-            if (_predicate(CurrentKeys.Path, CurrentKeys.Operation, operation))
+            foreach (var item in pathItem.Operations)
             {
-                _searchResults.Add(new SearchResult()
+                var operation = item.Value;
+                var operationType = item.Key;
+
+                if (_predicate(CurrentKeys.Path, operationType, operation))
                 {
-                    Operation = operation,
-                    CurrentKeys = CopyCurrentKeys(CurrentKeys)
-                });
+                    _searchResults.Add(new SearchResult()
+                    {
+                        Operation = operation,
+                        Parameters = pathItem.Parameters,
+                        CurrentKeys = CopyCurrentKeys(CurrentKeys, operationType)
+                    });
+                }
             }
         }
 
@@ -65,12 +72,12 @@ public override void Visit(IList<OpenApiParameter> parameters)
             base.Visit(parameters);
         }
 
-        private static CurrentKeys CopyCurrentKeys(CurrentKeys currentKeys)
+        private static CurrentKeys CopyCurrentKeys(CurrentKeys currentKeys, OperationType operationType)
         {
             return new CurrentKeys
             {
                 Path = currentKeys.Path,
-                Operation = currentKeys.Operation
+                Operation = operationType,
             };
         }
     }
diff --git a/src/Microsoft.OpenApi/Services/SearchResult.cs b/src/Microsoft.OpenApi/Services/SearchResult.cs
@@ -1,6 +1,7 @@
 ﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
+using System.Collections.Generic;
 using Microsoft.OpenApi.Models;
 
 namespace Microsoft.OpenApi.Services
@@ -19,5 +20,11 @@ public class SearchResult
         /// An Operation object.
         /// </summary>
         public OpenApiOperation Operation { get; set; }
+
+        /// <summary>
+        /// Parameters object
+        /// </summary>
+        public IList<OpenApiParameter> Parameters { get; set; }
+
     }
 }
diff --git a/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt b/test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt
@@ -1111,14 +1111,15 @@ namespace Microsoft.OpenApi.Services
     {
         public OperationSearch(System.Func<string, Microsoft.OpenApi.Models.OperationType?, Microsoft.OpenApi.Models.OpenApiOperation, bool> predicate) { }
         public System.Collections.Generic.IList<Microsoft.OpenApi.Services.SearchResult> SearchResults { get; }
-        public override void Visit(Microsoft.OpenApi.Models.OpenApiOperation operation) { }
+        public override void Visit(Microsoft.OpenApi.Models.OpenApiPathItem pathItem) { }
         public override void Visit(System.Collections.Generic.IList<Microsoft.OpenApi.Models.OpenApiParameter> parameters) { }
     }
     public class SearchResult
     {
         public SearchResult() { }
         public Microsoft.OpenApi.Services.CurrentKeys CurrentKeys { get; set; }
         public Microsoft.OpenApi.Models.OpenApiOperation Operation { get; set; }
+        public System.Collections.Generic.IList<Microsoft.OpenApi.Models.OpenApiParameter> Parameters { get; set; }
     }
 }
 namespace Microsoft.OpenApi.Validations

Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,21 @@ public static OpenApiDocument CreateOpenApiDocument()`
`116`	`116`	`}`
`117`	`117`	`}`
`118`	`118`	`}`
	`119`	`+ },`
	`120`	`+ Parameters = new List<OpenApiParameter>`
	`121`	`+ {`
	`122`	`+ {`
	`123`	`+ new OpenApiParameter()`
	`124`	`+ {`
	`125`	`+ Name = "period",`
	`126`	`+ In = ParameterLocation.Path,`
	`127`	`+ Required = true,`
	`128`	`+ Schema = new OpenApiSchema()`
	`129`	`+ {`
	`130`	`+ Type = "string"`
	`131`	`+ }`
	`132`	`+ }`
	`133`	`+ }`
`119`	`134`	`}`
`120`	`135`	`},`
`121`	`136`	`["/reports/microsoft.graph.getTeamsUserActivityUserDetail(date={date})"] = new OpenApiPathItem()`
`@@ -175,7 +190,20 @@ public static OpenApiDocument CreateOpenApiDocument()`
`175`	`190`	`}`
`176`	`191`	`}`
`177`	`192`	`}`
`178`		`- }`
	`193`	`+ },`
	`194`	`+ Parameters = new List<OpenApiParameter>`
	`195`	`+ {`
	`196`	`+ new OpenApiParameter`
	`197`	`+ {`
	`198`	`+ Name = "period",`
	`199`	`+ In = ParameterLocation.Path,`
	`200`	`+ Required = true,`
	`201`	`+ Schema = new OpenApiSchema()`
	`202`	`+ {`
	`203`	`+ Type = "string"`
	`204`	`+ }`
	`205`	`+ }`
	`206`	`+ }`
`179`	`207`	`},`
`180`	`208`	`["/users"] = new OpenApiPathItem()`
`181`	`209`	`{`
Original file line number	Diff line number	Diff line change
`@@ -164,6 +164,14 @@ public static OpenApiDocument CreateFilteredDocument(OpenApiDocument source, Fun`
`164`	`164`	`if (result.CurrentKeys.Operation != null)`
`165`	`165`	`{`
`166`	`166`	`pathItem.Operations.Add((OperationType)result.CurrentKeys.Operation, result.Operation);`
	`167`	`+`
	`168`	`+ if (result.Parameters?.Any() ?? false)`
	`169`	`+ {`
	`170`	`+ foreach (var parameter in result.Parameters)`
	`171`	`+ {`
	`172`	`+ pathItem.Parameters.Add(parameter);`
	`173`	`+ }`
	`174`	`+ }`
`167`	`175`	`}`
`168`	`176`	`}`
`169`	`177`
Original file line number	Diff line number	Diff line change
`@@ -31,18 +31,25 @@ public OperationSearch(Func<string, OperationType?,OpenApiOperation, bool> predi`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`/// <summary>`
`34`		`- /// Visits <see cref="OpenApiOperation"/>.`
	`34`	`+ /// Visits <see cref="OpenApiPathItem"/>`
`35`	`35`	`/// </summary>`
`36`		`- /// <param name="operation">The target <see cref="OpenApiOperation"/>.</param>`
`37`		`- public override void Visit(OpenApiOperation operation)`
	`36`	`+ /// <param name="pathItem"> The target <see cref="OpenApiPathItem"/>.</param>`
	`37`	`+ public override void Visit(OpenApiPathItem pathItem)`
`38`	`38`	`{`
`39`		`- if (_predicate(CurrentKeys.Path, CurrentKeys.Operation, operation))`
	`39`	`+ foreach (var item in pathItem.Operations)`
`40`	`40`	`{`
`41`		`- _searchResults.Add(new SearchResult()`
	`41`	`+ var operation = item.Value;`
	`42`	`+ var operationType = item.Key;`
	`43`	`+`
	`44`	`+ if (_predicate(CurrentKeys.Path, operationType, operation))`
`42`	`45`	`{`
`43`		`- Operation = operation,`
`44`		`- CurrentKeys = CopyCurrentKeys(CurrentKeys)`
`45`		`- });`
	`46`	`+ _searchResults.Add(new SearchResult()`
	`47`	`+ {`
	`48`	`+ Operation = operation,`
	`49`	`+ Parameters = pathItem.Parameters,`
	`50`	`+ CurrentKeys = CopyCurrentKeys(CurrentKeys, operationType)`
	`51`	`+ });`
	`52`	`+ }`
`46`	`53`	`}`
`47`	`54`	`}`
`48`	`55`
`@@ -65,12 +72,12 @@ public override void Visit(IList<OpenApiParameter> parameters)`
`65`	`72`	`base.Visit(parameters);`
`66`	`73`	`}`
`67`	`74`
`68`		`- private static CurrentKeys CopyCurrentKeys(CurrentKeys currentKeys)`
	`75`	`+ private static CurrentKeys CopyCurrentKeys(CurrentKeys currentKeys, OperationType operationType)`
`69`	`76`	`{`
`70`	`77`	`return new CurrentKeys`
`71`	`78`	`{`
`72`	`79`	`Path = currentKeys.Path,`
`73`		`- Operation = currentKeys.Operation`
	`80`	`+ Operation = operationType,`
`74`	`81`	`};`
`75`	`82`	`}`
`76`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1111,14 +1111,15 @@ namespace Microsoft.OpenApi.Services`
`1111`	`1111`	`{`
`1112`	`1112`	`public OperationSearch(System.Func<string, Microsoft.OpenApi.Models.OperationType?, Microsoft.OpenApi.Models.OpenApiOperation, bool> predicate) { }`
`1113`	`1113`	`public System.Collections.Generic.IList<Microsoft.OpenApi.Services.SearchResult> SearchResults { get; }`
`1114`		`- public override void Visit(Microsoft.OpenApi.Models.OpenApiOperation operation) { }`
	`1114`	`+ public override void Visit(Microsoft.OpenApi.Models.OpenApiPathItem pathItem) { }`
`1115`	`1115`	`public override void Visit(System.Collections.Generic.IList<Microsoft.OpenApi.Models.OpenApiParameter> parameters) { }`
`1116`	`1116`	`}`
`1117`	`1117`	`public class SearchResult`
`1118`	`1118`	`{`
`1119`	`1119`	`public SearchResult() { }`
`1120`	`1120`	`public Microsoft.OpenApi.Services.CurrentKeys CurrentKeys { get; set; }`
`1121`	`1121`	`public Microsoft.OpenApi.Models.OpenApiOperation Operation { get; set; }`
	`1122`	`+ public System.Collections.Generic.IList<Microsoft.OpenApi.Models.OpenApiParameter> Parameters { get; set; }`
`1122`	`1123`	`}`
`1123`	`1124`	`}`
`1124`	`1125`	`namespace Microsoft.OpenApi.Validations`