Updates PUT operation id prefix from Update to Set (#601)

irvinesunday · web-flow · commit 4f9bad6ea7d2 · 2024-10-26T01:06:28.000+03:00
* Disambiguate put and patch operation ids

* Update tests

* Updates release note
diff --git a/src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.csproj b/src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.csproj
@@ -15,7 +15,7 @@
     <TargetFrameworks>net8.0</TargetFrameworks>
     <PackageId>Microsoft.OpenApi.OData</PackageId>
     <SignAssembly>true</SignAssembly>
-    <Version>2.0.0-preview.6</Version>
+    <Version>2.0.0-preview.7</Version>
     <Description>This package contains the codes you need to convert OData CSDL to Open API Document of Model.</Description>
     <Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
     <PackageTags>Microsoft OpenApi OData EDM</PackageTags>
@@ -32,6 +32,7 @@
 		- Replaced integer types by number types
 		- 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
 	</PackageReleaseNotes>
     <AssemblyName>Microsoft.OpenApi.OData.Reader</AssemblyName>
     <AssemblyOriginatorKeyFile>..\..\tool\Microsoft.OpenApi.OData.snk</AssemblyOriginatorKeyFile>
diff --git a/src/Microsoft.OpenApi.OData.Reader/Operation/ComplexPropertyUpdateOperationHandler.cs b/src/Microsoft.OpenApi.OData.Reader/Operation/ComplexPropertyUpdateOperationHandler.cs
@@ -39,8 +39,9 @@ protected override void SetBasicInfo(OpenApiOperation operation)
 
         // OperationId
         if (Context.Settings.EnableOperationId)
-        {
-            operation.OperationId = EdmModelHelper.GenerateComplexPropertyPathOperationId(Path, Context, "Update");
+        {
+            string prefix = OperationType == OperationType.Patch ? "Update" : "Set";
+            operation.OperationId = EdmModelHelper.GenerateComplexPropertyPathOperationId(Path, Context, prefix);
         }
     }
 
diff --git a/src/Microsoft.OpenApi.OData.Reader/Operation/EntityUpdateOperationHandler.cs b/src/Microsoft.OpenApi.OData.Reader/Operation/EntityUpdateOperationHandler.cs
@@ -50,7 +50,8 @@ protected override void SetBasicInfo(OpenApiOperation operation)
             if (Context.Settings.EnableOperationId)
             {
                 string typeName = entityType.Name;
-                string operationName = $"Update{ Utils.UpperFirstChar(typeName)}";
+                string prefix = OperationType == OperationType.Patch ? "Update" : "Set";
+                string operationName = $"{prefix}{ Utils.UpperFirstChar(typeName)}";
                 if (keySegment.IsAlternateKey)
                 {
                     string alternateKeyName = string.Join("", keySegment.Identifier.Split(',').Select(static x => Utils.UpperFirstChar(x)));
diff --git a/src/Microsoft.OpenApi.OData.Reader/Operation/NavigationPropertyUpdateOperationHandler.cs b/src/Microsoft.OpenApi.OData.Reader/Operation/NavigationPropertyUpdateOperationHandler.cs
@@ -41,7 +41,7 @@ protected override void SetBasicInfo(OpenApiOperation operation)
             // OperationId
             if (Context.Settings.EnableOperationId)
             {
-                string prefix = "Update";
+                string prefix = OperationType == OperationType.Patch ? "Update" : "Set";
                 operation.OperationId = GetOperationId(prefix);
             }
 
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/ComplexPropertyPutOperationHandlerTests.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/ComplexPropertyPutOperationHandlerTests.cs
@@ -61,7 +61,7 @@ public void CreateComplexPropertyPutOperationReturnsCorrectOperationForSingle(bo
 
 		if (enableOperationId)
 		{
-			Assert.Equal("Customers.UpdateBillingAddress", put.OperationId);
+			Assert.Equal("Customers.SetBillingAddress", put.OperationId);
 		}
 		else
 		{
@@ -108,7 +108,7 @@ public void CreateComplexPropertyPutOperationReturnsCorrectOperationForCollectio
 
         if (enableOperationId)
 		{
-			Assert.Equal("Customers.UpdateAlternativeAddresses", put.OperationId);
+			Assert.Equal("Customers.SetAlternativeAddresses", put.OperationId);
 		}
 		else
 		{
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/EntityPutOperationHandlerTests.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/EntityPutOperationHandlerTests.cs
@@ -66,7 +66,7 @@ public void CreateEntityPutOperationReturnsCorrectOperation(bool enableOperation
 
             if (enableOperationId)
             {
-                Assert.Equal("Customers.Customer.UpdateCustomer", putOperation.OperationId);
+                Assert.Equal("Customers.Customer.SetCustomer", putOperation.OperationId);
             }
             else
             {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/NavigationPropertyPutOperationHandlerTests.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/NavigationPropertyPutOperationHandlerTests.cs
@@ -71,7 +71,7 @@ public void CreateNavigationPutOperationReturnsCorrectOperation(bool enableOpera
 
             if (enableOperationId)
             {
-                Assert.Equal("People.UpdateBestFriend", operation.OperationId);
+                Assert.Equal("People.SetBestFriend", operation.OperationId);
             }
             else
             {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.V2.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.V2.json
@@ -165,7 +165,7 @@
           "Airlines.Airline"
         ],
         "summary": "Update entity in Airlines",
-        "operationId": "Airlines.Airline.UpdateAirline",
+        "operationId": "Airlines.Airline.SetAirline",
         "consumes": [
           "application/json"
         ],
@@ -534,7 +534,7 @@
           "Airports.AirportLocation"
         ],
         "summary": "Update property Location value.",
-        "operationId": "Airports.UpdateLocation",
+        "operationId": "Airports.SetLocation",
         "consumes": [
           "application/json"
         ],
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.V2.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.V2.yaml
@@ -107,7 +107,7 @@ paths:
       tags:
         - Airlines.Airline
       summary: Update entity in Airlines
-      operationId: Airlines.Airline.UpdateAirline
+      operationId: Airlines.Airline.SetAirline
       consumes:
         - application/json
       parameters:
@@ -349,7 +349,7 @@ paths:
       tags:
         - Airports.AirportLocation
       summary: Update property Location value.
-      operationId: Airports.UpdateLocation
+      operationId: Airports.SetLocation
       consumes:
         - application/json
       parameters:
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.json
@@ -192,7 +192,7 @@
           "Airlines.Airline"
         ],
         "summary": "Update entity in Airlines",
-        "operationId": "Airlines.Airline.UpdateAirline",
+        "operationId": "Airlines.Airline.SetAirline",
         "parameters": [
           {
             "name": "AirlineCode",
@@ -609,7 +609,7 @@
           "Airports.AirportLocation"
         ],
         "summary": "Update property Location value.",
-        "operationId": "Airports.UpdateLocation",
+        "operationId": "Airports.SetLocation",
         "parameters": [
           {
             "name": "IcaoCode",
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.yaml
@@ -125,7 +125,7 @@ paths:
       tags:
         - Airlines.Airline
       summary: Update entity in Airlines
-      operationId: Airlines.Airline.UpdateAirline
+      operationId: Airlines.Airline.SetAirline
       parameters:
         - name: AirlineCode
           in: path
@@ -398,7 +398,7 @@ paths:
       tags:
         - Airports.AirportLocation
       summary: Update property Location value.
-      operationId: Airports.UpdateLocation
+      operationId: Airports.SetLocation
       parameters:
         - name: IcaoCode
           in: path

Original file line number	Diff line number	Diff line change
`@@ -39,8 +39,9 @@ protected override void SetBasicInfo(OpenApiOperation operation)`
`39`	`39`
`40`	`40`	`// OperationId`
`41`	`41`	`if (Context.Settings.EnableOperationId)`
`42`		`- {`
`43`		`- operation.OperationId = EdmModelHelper.GenerateComplexPropertyPathOperationId(Path, Context, "Update");`
	`42`	`+ {`
	`43`	`+ string prefix = OperationType == OperationType.Patch ? "Update" : "Set";`
	`44`	`+ operation.OperationId = EdmModelHelper.GenerateComplexPropertyPathOperationId(Path, Context, prefix);`
`44`	`45`	`}`
`45`	`46`	`}`
`46`	`47`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,8 @@ protected override void SetBasicInfo(OpenApiOperation operation)`
`50`	`50`	`if (Context.Settings.EnableOperationId)`
`51`	`51`	`{`
`52`	`52`	`string typeName = entityType.Name;`
`53`		`- string operationName = $"Update{ Utils.UpperFirstChar(typeName)}";`
	`53`	`+ string prefix = OperationType == OperationType.Patch ? "Update" : "Set";`
	`54`	`+ string operationName = $"{prefix}{ Utils.UpperFirstChar(typeName)}";`
`54`	`55`	`if (keySegment.IsAlternateKey)`
`55`	`56`	`{`
`56`	`57`	`string alternateKeyName = string.Join("", keySegment.Identifier.Split(',').Select(static x => Utils.UpperFirstChar(x)));`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ protected override void SetBasicInfo(OpenApiOperation operation)`
`41`	`41`	`// OperationId`
`42`	`42`	`if (Context.Settings.EnableOperationId)`
`43`	`43`	`{`
`44`		`- string prefix = "Update";`
	`44`	`+ string prefix = OperationType == OperationType.Patch ? "Update" : "Set";`
`45`	`45`	`operation.OperationId = GetOperationId(prefix);`
`46`	`46`	`}`
`47`	`47`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public void CreateComplexPropertyPutOperationReturnsCorrectOperationForSingle(bo`
`61`	`61`
`62`	`62`	`if (enableOperationId)`
`63`	`63`	`{`
`64`		`- Assert.Equal("Customers.UpdateBillingAddress", put.OperationId);`
	`64`	`+ Assert.Equal("Customers.SetBillingAddress", put.OperationId);`
`65`	`65`	`}`
`66`	`66`	`else`
`67`	`67`	`{`
`@@ -108,7 +108,7 @@ public void CreateComplexPropertyPutOperationReturnsCorrectOperationForCollectio`
`108`	`108`
`109`	`109`	`if (enableOperationId)`
`110`	`110`	`{`
`111`		`- Assert.Equal("Customers.UpdateAlternativeAddresses", put.OperationId);`
	`111`	`+ Assert.Equal("Customers.SetAlternativeAddresses", put.OperationId);`
`112`	`112`	`}`
`113`	`113`	`else`
`114`	`114`	`{`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public void CreateEntityPutOperationReturnsCorrectOperation(bool enableOperation`
`66`	`66`
`67`	`67`	`if (enableOperationId)`
`68`	`68`	`{`
`69`		`- Assert.Equal("Customers.Customer.UpdateCustomer", putOperation.OperationId);`
	`69`	`+ Assert.Equal("Customers.Customer.SetCustomer", putOperation.OperationId);`
`70`	`70`	`}`
`71`	`71`	`else`
`72`	`72`	`{`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public void CreateNavigationPutOperationReturnsCorrectOperation(bool enableOpera`
`71`	`71`
`72`	`72`	`if (enableOperationId)`
`73`	`73`	`{`
`74`		`- Assert.Equal("People.UpdateBestFriend", operation.OperationId);`
	`74`	`+ Assert.Equal("People.SetBestFriend", operation.OperationId);`
`75`	`75`	`}`
`76`	`76`	`else`
`77`	`77`	`{`