Update request body for ref POST operation

millicentachieng · millicentachieng · commit 2c3c51badd19 · 2022-06-29T11:37:55.000+03:00
diff --git a/src/Microsoft.OpenApi.OData.Reader/Common/Constants.cs b/src/Microsoft.OpenApi.OData.Reader/Common/Constants.cs
@@ -111,8 +111,13 @@ internal static class Constants
         public static string ReferenceUpdateSchemaName = "ReferenceUpdateSchema";
 
         /// <summary>
-        /// Name used for reference request body
+        /// Name used for reference request POST body
         /// </summary>
-        public static string ReferenceRequestPostBodyName = "refPostBody";
+        public static string ReferencePostRequestBodyName = "refPostBody";
+
+        /// <summary>
+        /// Name used for reference request PUT body
+        /// </summary>
+        public static string ReferencePutRequestBodyName = "refPutBody";
     }
 }
diff --git a/src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiRequestBodyGenerator.cs b/src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiRequestBodyGenerator.cs
@@ -98,25 +98,29 @@ public static IDictionary<string, OpenApiRequestBody> CreateRequestBodies(this O
             return new Dictionary<string, OpenApiRequestBody>
             {
                 {
-                    Constants.ReferenceRequestPostBodyName,
-                    CreateRefRequestBody() 
+                    Constants.ReferencePostRequestBodyName,
+                    CreateRefPostRequestBody() 
+                },
+                {
+                    Constants.ReferencePutRequestBodyName,
+                    CreateRefPutRequestBody()
                 }
             };
         }
 
         /// <summary>
-        /// Create a <see cref="OpenApiRequestBody"/> to be reused across ref POST and PUT operations
+        /// Create a <see cref="OpenApiRequestBody"/> to be reused across ref POST operations
         /// </summary>
         /// <returns>The created <see cref="OpenApiRequestBody"/></returns>
-        private static OpenApiRequestBody CreateRefRequestBody()
+        private static OpenApiRequestBody CreateRefPostRequestBody()
         {
             OpenApiSchema schema = new()
             {
                 UnresolvedReference = true,
                 Reference = new OpenApiReference
                 {
                     Type = ReferenceType.Schema,
-                    Id = Constants.ReferenceRequestPostBodyName
+                    Id = Constants.ReferencePostRequestBodyName
                 }
             };
             return new OpenApiRequestBody
@@ -134,5 +138,37 @@ private static OpenApiRequestBody CreateRefRequestBody()
                 }
             };
         }
+
+        /// <summary>
+        /// Create a <see cref="OpenApiRequestBody"/> to be reused across ref PUT operations
+        /// </summary>
+        /// <returns>The created <see cref="OpenApiRequestBody"/></returns>
+        private static OpenApiRequestBody CreateRefPutRequestBody()
+        {
+            OpenApiSchema schema = new()
+            {
+                UnresolvedReference = true,
+                Reference = new OpenApiReference
+                {
+                    Type = ReferenceType.Schema,
+                    Id = Constants.ReferenceUpdateSchemaName
+                }
+            };
+
+            return new OpenApiRequestBody
+            {
+                Required = true,
+                Description = "New navigation property ref values",
+                Content = new Dictionary<string, OpenApiMediaType>
+                {
+                    {
+                        Constants.ApplicationJsonMediaType, new OpenApiMediaType
+                        {
+                            Schema = schema
+                        }
+                    }
+                }
+            };
+        }
     }
 }
diff --git a/src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiSchemaGenerator.cs b/src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiSchemaGenerator.cs
@@ -107,7 +107,7 @@ public static IDictionary<string, OpenApiSchema> CreateSchemas(this ODataContext
                 };
             }
 
-            schemas[Constants.ReferenceRequestPostBodyName] = new()
+            schemas[Constants.ReferencePostRequestBodyName] = new()
             {
                 Type = "object",
                 Properties = new Dictionary<string, OpenApiSchema>
diff --git a/src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.csproj b/src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.csproj
@@ -26,7 +26,7 @@
 - Add error ranges for OData actions when ErrorResponsesAsDefault is set to false #218
 - Fixes missing bound operations on some navigation property paths #201
 - Provides support for using success status code range 2XX #153
-- Fixes request body and response representation for ref POST operations #228
+- Fixes request body and response representation for ref POST and PUT operations #228
 - Adds discriminator object to complex types which have derived types #233
     </PackageReleaseNotes>
     <AssemblyName>Microsoft.OpenApi.OData.Reader</AssemblyName>
diff --git a/src/Microsoft.OpenApi.OData.Reader/Operation/RefPostOperationHandler.cs b/src/Microsoft.OpenApi.OData.Reader/Operation/RefPostOperationHandler.cs
@@ -45,7 +45,7 @@ protected override void SetRequestBody(OpenApiOperation operation)
                 Reference = new OpenApiReference
                 {
                     Type = ReferenceType.RequestBody,
-                    Id = Constants.ReferenceRequestPostBodyName
+                    Id = Constants.ReferencePostRequestBodyName
                 }
             };
 
diff --git a/src/Microsoft.OpenApi.OData.Reader/Operation/RefPutOperationHandler.cs b/src/Microsoft.OpenApi.OData.Reader/Operation/RefPutOperationHandler.cs
@@ -40,16 +40,11 @@ protected override void SetRequestBody(OpenApiOperation operation)
         {
             operation.RequestBody = new OpenApiRequestBody
             {
-                Required = true,
-                Description = "New navigation property ref values",
-                Content = new Dictionary<string, OpenApiMediaType>
-                {
-                    {
-                        Constants.ApplicationJsonMediaType, new OpenApiMediaType
-                        {
-                            Schema = GetOpenApiSchema()
-                        }
-                    }
+                UnresolvedReference = true,
+                Reference = new OpenApiReference
+                {              
+                    Type = ReferenceType.RequestBody,
+                    Id = Constants.ReferencePutRequestBodyName
                 }
             };
 
@@ -59,7 +54,7 @@ protected override void SetRequestBody(OpenApiOperation operation)
         /// <inheritdoc/>
         protected override void SetResponses(OpenApiOperation operation)
         {
-    		operation.AddErrorResponses(Context.Settings, true, GetOpenApiSchema());
+    		operation.AddErrorResponses(Context.Settings, true, GetRefUpdateSchema());
             base.SetResponses(operation);
         }
 
@@ -91,7 +86,7 @@ protected override void AppendCustomParameters(OpenApiOperation operation)
             }
         }
 
-        private OpenApiSchema GetOpenApiSchema()
+        private OpenApiSchema GetRefUpdateSchema()
         {
             return new()
             {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiRequestBodyGeneratorTests.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiRequestBodyGeneratorTests.cs
@@ -159,12 +159,12 @@ public void CreateRefRequestBodies()
 
             // Act
             var requestBodies = context.CreateRequestBodies();
-            requestBodies.TryGetValue(Common.Constants.ReferenceRequestPostBodyName, out Models.OpenApiRequestBody refPostBody);
+            requestBodies.TryGetValue(Common.Constants.ReferencePostRequestBodyName, out Models.OpenApiRequestBody refPostBody);
 
             // Assert
             Assert.NotNull(refPostBody);
             Assert.Equal("New navigation property ref value", refPostBody.Description);
-            Assert.Equal(Common.Constants.ReferenceRequestPostBodyName, refPostBody.Content.First().Value.Schema.Reference.Id);
+            Assert.Equal(Common.Constants.ReferencePostRequestBodyName, refPostBody.Content.First().Value.Schema.Reference.Id);
         }
     }
 }
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiSchemaGeneratorTests.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiSchemaGeneratorTests.cs
@@ -74,7 +74,7 @@ public void CreatesRefRequestBodySchema()
             // Act & Assert
             var schemas = context.CreateSchemas();
 
-            schemas.TryGetValue(Constants.ReferenceRequestPostBodyName, out OpenApiSchema refRequestBody);
+            schemas.TryGetValue(Constants.ReferencePostRequestBodyName, out OpenApiSchema refRequestBody);
 
             Assert.NotNull(refRequestBody);
             Assert.Equal("object", refRequestBody.Type);
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/RefPostOperationHandlerTests.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/RefPostOperationHandlerTests.cs
@@ -56,7 +56,7 @@ public void CreateNavigationRefPostOperationReturnsCorrectOperation(bool enableO
 
             Assert.NotNull(operation.RequestBody);
             Assert.Equal(Models.ReferenceType.RequestBody, operation.RequestBody.Reference.Type);
-            Assert.Equal(Common.Constants.ReferenceRequestPostBodyName, operation.RequestBody.Reference.Id);
+            Assert.Equal(Common.Constants.ReferencePostRequestBodyName, operation.RequestBody.Reference.Id);
 
             Assert.Equal(2, operation.Responses.Count);
             var statusCode = useHTTPStatusCodeClass2XX ? "2XX" : "204";
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/RefPutOperationHandlerTests.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/RefPutOperationHandlerTests.cs
@@ -54,8 +54,8 @@ public void CreateNavigationRefPutOperationReturnsCorrectOperation(bool enableOp
             Assert.NotNull(operation.Parameters);
             Assert.Equal(1, operation.Parameters.Count);
 
-            Assert.NotNull(operation.RequestBody);
-            Assert.Equal("New navigation property ref values", operation.RequestBody.Description);
+            Assert.Equal(Models.ReferenceType.RequestBody, operation.RequestBody.Reference.Type);
+            Assert.Equal(Common.Constants.ReferencePutRequestBodyName, operation.RequestBody.Reference.Id);
 
             Assert.Equal(2, operation.Responses.Count);
             var statusCode = useHTTPStatusCodeClass2XX ? "2XX" : "204";
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.json
@@ -1369,6 +1369,17 @@
           }
         },
         "required": true
+      },
+      "refPutBody": {
+        "description": "New navigation property ref values",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/ReferenceUpdateSchema"
+            }
+          }
+        },
+        "required": true
       }
     }
   },
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.yaml
@@ -904,6 +904,13 @@ components:
           schema:
             $ref: '#/components/schemas/refPostBody'
       required: true
+    refPutBody:
+      description: New navigation property ref values
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/ReferenceUpdateSchema'
+      required: true
 tags:
   - name: City.City
     x-ms-docs-toc-type: page
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.json
@@ -169,6 +169,17 @@
           }
         },
         "required": true
+      },
+      "refPutBody": {
+        "description": "New navigation property ref values",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/ReferenceUpdateSchema"
+            }
+          }
+        },
+        "required": true
       }
     }
   }
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.yaml
@@ -114,4 +114,11 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/refPostBody'
+      required: true
+    refPutBody:
+      description: New navigation property ref values
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/ReferenceUpdateSchema'
       required: true
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
@@ -2507,9 +2507,7 @@
         ],
         "summary": "Update the ref of navigation property Document in Revisions",
         "operationId": "Revisions.UpdateRefDocument",
-        "consumes": [
-          "application/json"
-        ],
+        "consumes": [ ],
         "parameters": [
           {
             "in": "path",
@@ -2525,11 +2523,7 @@
           {
             "in": "body",
             "name": "body",
-            "description": "New navigation property ref values",
-            "required": true,
-            "schema": {
-              "$ref": "#/definitions/ReferenceUpdateSchema"
-            }
+            "schema": { }
           }
         ],
         "responses": {
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
@@ -1810,8 +1810,7 @@ paths:
         - Revisions.Document
       summary: Update the ref of navigation property Document in Revisions
       operationId: Revisions.UpdateRefDocument
-      consumes:
-        - application/json
+      consumes: [ ]
       parameters:
         - in: path
           name: Id
@@ -1824,10 +1823,7 @@ paths:
           x-ms-docs-key-type: RevisionDto
         - in: body
           name: body
-          description: New navigation property ref values
-          required: true
-          schema:
-            $ref: '#/definitions/ReferenceUpdateSchema'
+          schema: { }
       responses:
         '204':
           description: Success
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
@@ -2879,15 +2879,7 @@
           }
         ],
         "requestBody": {
-          "description": "New navigation property ref values",
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/ReferenceUpdateSchema"
-              }
-            }
-          },
-          "required": true
+          "$ref": "#/components/requestBodies/refPutBody"
         },
         "responses": {
           "204": {
@@ -7140,6 +7132,17 @@
           }
         },
         "required": true
+      },
+      "refPutBody": {
+        "description": "New navigation property ref values",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/ReferenceUpdateSchema"
+            }
+          }
+        },
+        "required": true
       }
     }
   },
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
@@ -2054,12 +2054,7 @@ paths:
             format: int32
           x-ms-docs-key-type: RevisionDto
       requestBody:
-        description: New navigation property ref values
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/ReferenceUpdateSchema'
-        required: true
+        $ref: '#/components/requestBodies/refPutBody'
       responses:
         '204':
           description: Success
@@ -5182,6 +5177,13 @@ components:
           schema:
             $ref: '#/components/schemas/refPostBody'
       required: true
+    refPutBody:
+      description: New navigation property ref values
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/ReferenceUpdateSchema'
+      required: true
 tags:
   - name: Categories.CategoryDto
     x-ms-docs-toc-type: page
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
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
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.json b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.json
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.yaml b/test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.yaml

Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ public static IDictionary<string, OpenApiSchema> CreateSchemas(this ODataContext`
`107`	`107`	`};`
`108`	`108`	`}`
`109`	`109`
`110`		`- schemas[Constants.ReferenceRequestPostBodyName] = new()`
	`110`	`+ schemas[Constants.ReferencePostRequestBodyName] = new()`
`111`	`111`	`{`
`112`	`112`	`Type = "object",`
`113`	`113`	`Properties = new Dictionary<string, OpenApiSchema>`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ protected override void SetRequestBody(OpenApiOperation operation)`
`45`	`45`	`Reference = new OpenApiReference`
`46`	`46`	`{`
`47`	`47`	`Type = ReferenceType.RequestBody,`
`48`		`- Id = Constants.ReferenceRequestPostBodyName`
	`48`	`+ Id = Constants.ReferencePostRequestBodyName`
`49`	`49`	`}`
`50`	`50`	`};`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -40,16 +40,11 @@ protected override void SetRequestBody(OpenApiOperation operation)`
`40`	`40`	`{`
`41`	`41`	`operation.RequestBody = new OpenApiRequestBody`
`42`	`42`	`{`
`43`		`- Required = true,`
`44`		`- Description = "New navigation property ref values",`
`45`		`- Content = new Dictionary<string, OpenApiMediaType>`
`46`		`- {`
`47`		`- {`
`48`		`- Constants.ApplicationJsonMediaType, new OpenApiMediaType`
`49`		`- {`
`50`		`- Schema = GetOpenApiSchema()`
`51`		`- }`
`52`		`- }`
	`43`	`+ UnresolvedReference = true,`
	`44`	`+ Reference = new OpenApiReference`
	`45`	`+ {`
	`46`	`+ Type = ReferenceType.RequestBody,`
	`47`	`+ Id = Constants.ReferencePutRequestBodyName`
`53`	`48`	`}`
`54`	`49`	`};`
`55`	`50`
`@@ -59,7 +54,7 @@ protected override void SetRequestBody(OpenApiOperation operation)`
`59`	`54`	`/// <inheritdoc/>`
`60`	`55`	`protected override void SetResponses(OpenApiOperation operation)`
`61`	`56`	`{`
`62`		`- operation.AddErrorResponses(Context.Settings, true, GetOpenApiSchema());`
	`57`	`+ operation.AddErrorResponses(Context.Settings, true, GetRefUpdateSchema());`
`63`	`58`	`base.SetResponses(operation);`
`64`	`59`	`}`
`65`	`60`
`@@ -91,7 +86,7 @@ protected override void AppendCustomParameters(OpenApiOperation operation)`
`91`	`86`	`}`
`92`	`87`	`}`
`93`	`88`
`94`		`- private OpenApiSchema GetOpenApiSchema()`
	`89`	`+ private OpenApiSchema GetRefUpdateSchema()`
`95`	`90`	`{`
`96`	`91`	`return new()`
`97`	`92`	`{`
Original file line number	Diff line number	Diff line change
`@@ -159,12 +159,12 @@ public void CreateRefRequestBodies()`
`159`	`159`
`160`	`160`	`// Act`
`161`	`161`	`var requestBodies = context.CreateRequestBodies();`
`162`		`- requestBodies.TryGetValue(Common.Constants.ReferenceRequestPostBodyName, out Models.OpenApiRequestBody refPostBody);`
	`162`	`+ requestBodies.TryGetValue(Common.Constants.ReferencePostRequestBodyName, out Models.OpenApiRequestBody refPostBody);`
`163`	`163`
`164`	`164`	`// Assert`
`165`	`165`	`Assert.NotNull(refPostBody);`
`166`	`166`	`Assert.Equal("New navigation property ref value", refPostBody.Description);`
`167`		`- Assert.Equal(Common.Constants.ReferenceRequestPostBodyName, refPostBody.Content.First().Value.Schema.Reference.Id);`
	`167`	`+ Assert.Equal(Common.Constants.ReferencePostRequestBodyName, refPostBody.Content.First().Value.Schema.Reference.Id);`
`168`	`168`	`}`
`169`	`169`	`}`
`170`	`170`	`}`