Merge pull request #629 from microsoft/fix/port-601

Updates PUT operation id prefix from Update to Set (#601)
microsoft · Jan 2, 2025 · 481ad4b · 481ad4b
2 parents efa9aad + c89dc73
commit 481ad4b
Show file tree

Hide file tree

Showing 10 changed files with 42 additions and 40 deletions.
diff --git a/src/Microsoft.OpenApi.OData.Reader/Operation/ComplexPropertyUpdateOperationHandler.cs b/src/Microsoft.OpenApi.OData.Reader/Operation/ComplexPropertyUpdateOperationHandler.cs
@@ -23,9 +23,9 @@ protected override void Initialize(ODataContext context, ODataPath path)
     {
         base.Initialize(context, path);
 
-        _updateRestrictions = Context.Model.GetRecord<UpdateRestrictionsType>(TargetPath, CapabilitiesConstants.UpdateRestrictions);
-        var complexPropertyUpdateRestrictions = Context.Model.GetRecord<UpdateRestrictionsType>(ComplexPropertySegment.Property, CapabilitiesConstants.UpdateRestrictions);
-        _updateRestrictions?.MergePropertiesIfNull(complexPropertyUpdateRestrictions);
+        _updateRestrictions = Context.Model.GetRecord<UpdateRestrictionsType>(TargetPath, CapabilitiesConstants.UpdateRestrictions);
+        var complexPropertyUpdateRestrictions = Context.Model.GetRecord<UpdateRestrictionsType>(ComplexPropertySegment.Property, CapabilitiesConstants.UpdateRestrictions);
+        _updateRestrictions?.MergePropertiesIfNull(complexPropertyUpdateRestrictions);
         _updateRestrictions ??= complexPropertyUpdateRestrictions;
     }
 
@@ -40,7 +40,8 @@ protected override void SetBasicInfo(OpenApiOperation operation)
         // OperationId
         if (Context.Settings.EnableOperationId)
         {
-            operation.OperationId = EdmModelHelper.GenerateComplexPropertyPathOperationId(Path, "Update");
+            string prefix = OperationType == OperationType.Patch ? "Update" : "Set";
+            operation.OperationId = EdmModelHelper.GenerateComplexPropertyPathOperationId(Path, prefix);
         }
     }
 
@@ -101,37 +102,37 @@ protected override void AppendCustomParameters(OpenApiOperation operation)
 
     private OpenApiSchema GetOpenApiSchema()
     {
-        var schema = new OpenApiSchema
-        {
-            UnresolvedReference = true,
-            Reference = new OpenApiReference
-            {
-                Type = ReferenceType.Schema,
-                Id = ComplexPropertySegment.ComplexType.FullName()
-            }
-        };
-
-        if (ComplexPropertySegment.Property.Type.IsCollection())
-        {
+        var schema = new OpenApiSchema
+        {
+            UnresolvedReference = true,
+            Reference = new OpenApiReference
+            {
+                Type = ReferenceType.Schema,
+                Id = ComplexPropertySegment.ComplexType.FullName()
+            }
+        };
+
+        if (ComplexPropertySegment.Property.Type.IsCollection())
+        {
             return new OpenApiSchema
             {
                 Type = Constants.ObjectType,
-                Properties = new Dictionary<string, OpenApiSchema>
-                {
-                    {
+                Properties = new Dictionary<string, OpenApiSchema>
+                {
+                    {
                         "value",
                         new OpenApiSchema
                         {
                             Type = "array",
                             Items = schema
-                        }
-                    }
+                        }
+                    }
                 }
-            };
-        }
-        else
-        {
-            return schema;
+            };
+        }
+        else
+        {
+            return schema;
         }
     }
 }
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/...Microsoft.OpenAPI.OData.Reader.Tests/Operation/ComplexPropertyPutOperationHandlerTests.cs b/...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/...rosoft.OpenAPI.OData.Reader.Tests/Operation/NavigationPropertyPutOperationHandlerTests.cs b/...rosoft.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 change
@@ Expand Up @@
                 if (enableOperationId)
                 {
-                    Assert.Equal("Customers.Customer.UpdateCustomer", putOperation.OperationId);
+                    Assert.Equal("Customers.Customer.SetCustomer", putOperation.OperationId);
                 }
                 else
                 {
@@ Expand Down @@