Reflection of #642

microsoft · Jan 20, 2025 · 740d254 · 740d254
1 parent 547c7c0
commit 740d254
Show file tree

Hide file tree

Showing 12 changed files with 188 additions and 96 deletions.
diff --git a/src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.csproj b/src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.csproj
@@ -33,6 +33,7 @@
 		- Further fix for generating unique operation ids for paths with composable overloaded functions where all functions in path are overloaded #594
 		- Further fix for generating unique operation ids for navigation property paths with composable overloaded functions #596
 		- Updates PUT operation id prefix from Update to Set #600
+    - Adds action/function suffix to tag names for actions/functions operations #641
 	</PackageReleaseNotes>
     <AssemblyName>Microsoft.OpenApi.OData.Reader</AssemblyName>
     <AssemblyOriginatorKeyFile>..\..\tool\Microsoft.OpenApi.OData.snk</AssemblyOriginatorKeyFile>

diff --git a/src/Microsoft.OpenApi.OData.Reader/Operation/EdmOperationOperationHandler.cs b/src/Microsoft.OpenApi.OData.Reader/Operation/EdmOperationOperationHandler.cs
@@ -171,22 +171,17 @@ private void GenerateTagName(out string tagName, int skip = 1)
                     skip += 1;
                     GenerateTagName(out tagName, skip);
                     break;
-                // If the operation is a function or action, append the word "Function" or "Action" to the tag name
-                case ODataOperationSegment operationSegment:
+                default:
                     tagName = NavigationSource.Name + "." + NavigationSource.EntityType.Name;
-                    if(operationSegment.Operation.IsAction())
+                    if (EdmOperation.IsAction())
                     {
                         tagName += ".Actions";
                     }
-
-                    if(operationSegment.Operation.IsFunction())
+                    else if (EdmOperation.IsFunction())
                     {
                         tagName += ".Functions";
                     }
                     break;
-                default:
-                    tagName = NavigationSource.Name + "." + NavigationSource.EntityType.Name;
-                    break;
             }
         }
 

diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/EdmActionOperationHandlerTests.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/EdmActionOperationHandlerTests.cs
@@ -40,7 +40,7 @@ public void CreateOperationForEdmActionReturnsCorrectOperation()
             Assert.Equal("Details of the shared trip.", operation.Description);
             Assert.NotNull(operation.Tags);
             var tag = Assert.Single(operation.Tags);
-            Assert.Equal("People.Person", tag.Name);
+            Assert.Equal("People.Person.Actions", tag.Name);
 
             Assert.NotNull(operation.Parameters);
             Assert.Single(operation.Parameters);
@@ -79,7 +79,7 @@ public void CreateOperationForEdmActionReturnsCorrectOperationHierarchicalClass(
             Assert.Equal($"Invoke action {actionName}", operation.Summary);
             Assert.NotNull(operation.Tags);
             var tag = Assert.Single(operation.Tags);
-            Assert.Equal($"{entitySetName}.AccountApiModel", tag.Name);
+            Assert.Equal($"{entitySetName}.AccountApiModel.Actions", tag.Name);
 
             Assert.NotNull(operation.Parameters);
             Assert.Single(operation.Parameters);

diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/EdmFunctionOperationHandlerTests.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/EdmFunctionOperationHandlerTests.cs
@@ -100,7 +100,7 @@ public void CreateOperationForEdmFunctionReturnsCorrectOperation(bool useHTTPSta
             Assert.Equal("Invoke function GetFavoriteAirline", operation.Summary);
             Assert.NotNull(operation.Tags);
             var tag = Assert.Single(operation.Tags);
-            Assert.Equal("People.Person", tag.Name);
+            Assert.Equal("People.Person.Functions", tag.Name);
 
             Assert.NotNull(operation.Parameters);
             Assert.Single(operation.Parameters);
@@ -138,7 +138,7 @@ public void CreateOperationForEdmFunctionReturnsCorrectOperationHierarchicalClas
             Assert.Equal("Collection of contract attachments.", operation.Description);
             Assert.NotNull(operation.Tags);
             var tag = Assert.Single(operation.Tags);
-            Assert.Equal($"{entitySetName}.AccountApiModel", tag.Name);
+            Assert.Equal($"{entitySetName}.AccountApiModel.Functions", tag.Name);
 
             Assert.NotNull(operation.Parameters);
             Assert.Equal(6, operation.Parameters.Count); // id, top, skip, count, search, filter
@@ -378,10 +378,10 @@ public void CreateOperationForComposableOverloadEdmFunctionReturnsCorrectOperati
 
             if (enableOperationId)
             {
-                Assert.Equal("Customers.Customer.MyFunction1.MyFunction2-c53d", operation1.OperationId);
-                Assert.Equal("Customers.Customer.MyFunction1.MyFunction2-4d93", operation2.OperationId);
-                Assert.Equal("Customers.Customer.MyFunction1.MyFunction2-a2b2", operation3.OperationId);
-                Assert.Equal("Customers.Customer.MyFunction1.MyFunction2-7bea", operation4.OperationId);
+                Assert.Equal("Customers.Customer.MyFunction1.MyFunction2-6b6d", operation1.OperationId);
+                Assert.Equal("Customers.Customer.MyFunction1.MyFunction2-2636", operation2.OperationId);
+                Assert.Equal("Customers.Customer.MyFunction1.MyFunction2-6b6d", operation3.OperationId);
+                Assert.Equal("Customers.Customer.MyFunction1.MyFunction2-2636", operation4.OperationId);
             }
             else
             {

diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V2.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V2.json
@@ -591,7 +591,7 @@
     "/Documents({Id})/Default.Upload": {
       "post": {
         "tags": [
-          "Documents.DocumentDto"
+          "Documents.DocumentDto.Actions"
         ],
         "summary": "Invoke action Upload",
         "operationId": "Documents.DocumentDto.Upload",
@@ -3519,7 +3519,7 @@
     "/Tasks({Id})/Default.Upload": {
       "post": {
         "tags": [
-          "Tasks.DocumentDto"
+          "Tasks.DocumentDto.Actions"
         ],
         "summary": "Invoke action Upload",
         "operationId": "Tasks.DocumentDto.Upload",
@@ -6275,6 +6275,10 @@
       "name": "Documents.DocumentDto",
       "x-ms-docs-toc-type": "page"
     },
+    {
+      "name": "Documents.DocumentDto.Actions",
+      "x-ms-docs-toc-type": "container"
+    },
     {
       "name": "Documents.RevisionDto",
       "x-ms-docs-toc-type": "page"
@@ -6315,6 +6319,10 @@
       "name": "Tasks.DocumentDto",
       "x-ms-docs-toc-type": "page"
     },
+    {
+      "name": "Tasks.DocumentDto.Actions",
+      "x-ms-docs-toc-type": "container"
+    },
     {
       "name": "Tasks.RevisionDto",
       "x-ms-docs-toc-type": "page"

diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V2.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V2.yaml
@@ -413,7 +413,7 @@ paths:
   '/Documents({Id})/Default.Upload':
     post:
       tags:
-        - Documents.DocumentDto
+        - Documents.DocumentDto.Actions
       summary: Invoke action Upload
       operationId: Documents.DocumentDto.Upload
       parameters:
@@ -2495,7 +2495,7 @@ paths:
   '/Tasks({Id})/Default.Upload':
     post:
       tags:
-        - Tasks.DocumentDto
+        - Tasks.DocumentDto.Actions
       summary: Invoke action Upload
       operationId: Tasks.DocumentDto.Upload
       parameters:
@@ -4545,6 +4545,8 @@ tags:
     x-ms-docs-toc-type: page
   - name: Documents.DocumentDto
     x-ms-docs-toc-type: page
+  - name: Documents.DocumentDto.Actions
+    x-ms-docs-toc-type: container
   - name: Documents.RevisionDto
     x-ms-docs-toc-type: page
   - name: Documents.DocumentTagRelDto
@@ -4565,6 +4567,8 @@ tags:
     x-ms-docs-toc-type: page
   - name: Tasks.DocumentDto
     x-ms-docs-toc-type: page
+  - name: Tasks.DocumentDto.Actions
+    x-ms-docs-toc-type: container
   - name: Tasks.RevisionDto
     x-ms-docs-toc-type: page
   - name: Tasks.DocumentTagRelDto

diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.json
@@ -663,7 +663,7 @@
       "description": "Provides operations to call the Upload method.",
       "post": {
         "tags": [
-          "Documents.DocumentDto"
+          "Documents.DocumentDto.Actions"
         ],
         "summary": "Invoke action Upload",
         "operationId": "Documents.DocumentDto.Upload",
@@ -3940,7 +3940,7 @@
       "description": "Provides operations to call the Upload method.",
       "post": {
         "tags": [
-          "Tasks.DocumentDto"
+          "Tasks.DocumentDto.Actions"
         ],
         "summary": "Invoke action Upload",
         "operationId": "Tasks.DocumentDto.Upload",
@@ -7481,6 +7481,10 @@
       "name": "Documents.DocumentDto",
       "x-ms-docs-toc-type": "page"
     },
+    {
+      "name": "Documents.DocumentDto.Actions",
+      "x-ms-docs-toc-type": "container"
+    },
     {
       "name": "Documents.RevisionDto",
       "x-ms-docs-toc-type": "page"
@@ -7521,6 +7525,10 @@
       "name": "Tasks.DocumentDto",
       "x-ms-docs-toc-type": "page"
     },
+    {
+      "name": "Tasks.DocumentDto.Actions",
+      "x-ms-docs-toc-type": "container"
+    },
     {
       "name": "Tasks.RevisionDto",
       "x-ms-docs-toc-type": "page"

diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.yaml
@@ -460,7 +460,7 @@ paths:
     description: Provides operations to call the Upload method.
     post:
       tags:
-        - Documents.DocumentDto
+        - Documents.DocumentDto.Actions
       summary: Invoke action Upload
       operationId: Documents.DocumentDto.Upload
       parameters:
@@ -2771,7 +2771,7 @@ paths:
     description: Provides operations to call the Upload method.
     post:
       tags:
-        - Tasks.DocumentDto
+        - Tasks.DocumentDto.Actions
       summary: Invoke action Upload
       operationId: Tasks.DocumentDto.Upload
       parameters:
@@ -5384,6 +5384,8 @@ tags:
     x-ms-docs-toc-type: page
   - name: Documents.DocumentDto
     x-ms-docs-toc-type: page
+  - name: Documents.DocumentDto.Actions
+    x-ms-docs-toc-type: container
   - name: Documents.RevisionDto
     x-ms-docs-toc-type: page
   - name: Documents.DocumentTagRelDto
@@ -5404,6 +5406,8 @@ tags:
     x-ms-docs-toc-type: page
   - name: Tasks.DocumentDto
     x-ms-docs-toc-type: page
+  - name: Tasks.DocumentDto.Actions
+    x-ms-docs-toc-type: container
   - name: Tasks.RevisionDto
     x-ms-docs-toc-type: page
   - name: Tasks.DocumentTagRelDto