Merge pull request #1465 from microsoftgraph/fix/is/singularize-drives

Add entry for `drives` to Humanizer Vocabulary to properly singularize to `drive`
microsoftgraph · Mar 31, 2023 · 2f0c4f3 · 2f0c4f3
2 parents 7ad72d2 + 3a936b6
commit 2f0c4f3
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 2 deletions.
diff --git a/OpenAPIService.Test/OpenAPIDocumentCreatorMock.cs b/OpenAPIService.Test/OpenAPIDocumentCreatorMock.cs
@@ -578,6 +578,37 @@ private OpenApiDocument CreateOpenApiDocument()
                             }
                         }
                     },
+                    ["/drives"] = new OpenApiPathItem()
+                    {
+                        Operations = new Dictionary<OperationType, OpenApiOperation>
+                        {
+                            {
+                                OperationType.Get, new OpenApiOperation
+                                {
+                                    Tags = new List<OpenApiTag>
+                                    {
+                                        {
+                                            new OpenApiTag()
+                                            {
+                                                Name = "drives.drive"
+                                            }
+                                        }
+                                    },
+                                    OperationId = "drives.drive.ListDrive",
+                                    Summary = "Get Drive",
+                                    Responses = new OpenApiResponses()
+                                    {
+                                        {
+                                            "200", new OpenApiResponse()
+                                            {
+                                                Description = "Success"
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    },
                     ["/security/hostSecurityProfiles"] = new OpenApiPathItem()
                     {
                         Operations = new Dictionary<OperationType, OpenApiOperation>

diff --git a/OpenAPIService.Test/OpenAPIServiceShould.cs b/OpenAPIService.Test/OpenAPIServiceShould.cs
@@ -358,7 +358,7 @@ public void RetrieveAllOperationsAndPaths()
             subsetOpenApiDocument = _openApiService.ApplyStyle(OpenApiStyle.Plain, subsetOpenApiDocument);
 
             // Assert
-            Assert.Equal(16, subsetOpenApiDocument.Paths.Count);
+            Assert.Equal(17, subsetOpenApiDocument.Paths.Count);
             Assert.NotEmpty(subsetOpenApiDocument.Components.Schemas);
             Assert.NotEmpty(subsetOpenApiDocument.Components.Parameters);
             Assert.NotEmpty(subsetOpenApiDocument.Components.Responses);
@@ -412,6 +412,29 @@ public void ResolveActionFunctionOperationIdsForPowerShellStyle(string url, Oper
             Assert.Equal(expectedOperationId, operationId);
         }
 
+        [Theory]
+        [InlineData("drives.drive.ListDrive", "drive_ListDrive", OperationType.Get)]
+        [InlineData("applications.application.UpdateLogo", "application_SetLogo", OperationType.Put)]
+        public void SingularizeAndDeduplicateOperationIdsForPowerShellStyle(string operationId, string expectedOperationId, OperationType operationType)
+        {
+            // Act
+            var predicate = _openApiService.CreatePredicate(operationIds: operationId,
+                                                           tags: null,
+                                                           url: null,
+                                                           source: _graphMockSource,
+                                                           graphVersion: GraphVersion);
+
+            var subsetOpenApiDocument = _openApiService.CreateFilteredDocument(_graphMockSource, Title, GraphVersion, predicate);
+            subsetOpenApiDocument = _openApiService.ApplyStyle(OpenApiStyle.PowerShell, subsetOpenApiDocument, singularizeOperationIds: true);
+            var singularizedOpId = subsetOpenApiDocument.Paths
+                                  .FirstOrDefault().Value
+                                  .Operations[operationType]
+                                  .OperationId;
+
+            // Assert
+            Assert.Equal(expectedOperationId, singularizedOpId);
+        }
+
         [Fact]
         public void ResolveStructuredAndCollectionValuedFunctionParameters()
         {

diff --git a/OpenAPIService/PowershellFormatter.cs b/OpenAPIService/PowershellFormatter.cs
@@ -1,8 +1,9 @@
-// ------------------------------------------------------------------------------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------------------------------------------------------------------------------
 //  Copyright (c) Microsoft Corporation.  All Rights Reserved.  Licensed under the MIT License.  See License in the project root for license information.
 // ------------------------------------------------------------------------------------------------------------------------------------------------------
 
 using Humanizer;
+using Humanizer.Inflections;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Services;
@@ -216,6 +217,9 @@ private static string SingularizeAndDeduplicateOperationId(string operationId)
             if (string.IsNullOrEmpty(operationId))
                 return operationId;
 
+            // drives does not properly singularize to drive.
+            Vocabularies.Default.AddSingular("(drive)s$", "$1");
+
             var segments = operationId.Split('.').ToList();
 
             // The last segment is ignored as a rule.