fix: normalizes request bodies adding pattern

Signed-off-by: Vincent Biret <[email protected]>

Author: baywet

src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiComponentsGenerator.cs

@@ -28,11 +28,11 @@ public static OpenApiComponents CreateComponents(this ODataContext context, Open
 
             context.AddSchemasToDocument(document);
             context.AddParametersToDocument(document);
+            context.AddResponsesToDocument(document);
+            context.AddRequestBodiesToDocument(document);
             //TODO convert all other create methods to add
-            document.Components.Responses = context.CreateResponses(document);
-            document.Components.RequestBodies = context.CreateRequestBodies(document);
-            document.Components.Examples = context.CreateExamples(document);
-            document.Components.SecuritySchemes = context.CreateSecuritySchemes();
+            context.CreateExamples(document);
+            context.CreateSecuritySchemes();
             document.Components.Links = null;
             document.Components.Callbacks = null;
             document.Components.Extensions = null;

src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiParameterGenerator.cs

@@ -30,7 +30,6 @@ internal static class OpenApiParameterGenerator
         /// </summary>
         /// <param name="context">The OData context.</param>
         /// <param name="document">The Open API document.</param>
-        /// <returns>The created map of <see cref="OpenApiParameter"/> object.</returns>
         public static void AddParametersToDocument(this ODataContext context, OpenApiDocument document)
         {
             Utils.CheckArgumentNull(context, nameof(context));

src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiRequestBodyGenerator.cs

@@ -96,34 +96,21 @@ public static OpenApiRequestBody CreateRequestBody(this ODataContext context, IE
         /// </summary>
         /// <param name="context">The OData context.</param>
         /// <param name="document">The OpenApi document to lookup references.</param>
-        /// <returns>The created dictionary of <see cref="OpenApiRequestBody"/> indexed by ref name</returns>
-        public static IDictionary<string, OpenApiRequestBody> CreateRequestBodies(this ODataContext context, OpenApiDocument document)
+        public static void AddRequestBodiesToDocument(this ODataContext context, OpenApiDocument document)
         {
             Utils.CheckArgumentNull(context, nameof(context));
             Utils.CheckArgumentNull(document, nameof(document));
 
-            Dictionary<string, OpenApiRequestBody> requestBodies = new()
-            {
-                {
-                    Constants.ReferencePostRequestBodyName,
-                    CreateRefPostRequestBody(document)
-                },
-                {
-                    Constants.ReferencePutRequestBodyName,
-                    CreateRefPutRequestBody(document)
-                }
-            };
+            document.AddComponent(Constants.ReferencePostRequestBodyName, CreateRefPostRequestBody(document));
+            document.AddComponent(Constants.ReferencePutRequestBodyName, CreateRefPutRequestBody(document));
 
             // add request bodies for actions targeting multiple related paths
             foreach (IEdmAction action in context.Model.SchemaElements.OfType<IEdmAction>()
-                .Where(action => context.Model.OperationTargetsMultiplePaths(action)))
+                .Where(context.Model.OperationTargetsMultiplePaths))
             {
-                OpenApiRequestBody requestBody = context.CreateRequestBody(action, document);
-                if (requestBody != null)
-                    requestBodies.Add($"{action.Name}RequestBody", requestBody);
+                if (context.CreateRequestBody(action, document) is OpenApiRequestBody requestBody)
+                    document.AddComponent($"{action.Name}RequestBody", requestBody);
             }
-      
-            return requestBodies;
         }
 
         /// <summary>

src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiResponseGenerator.cs

@@ -63,10 +63,10 @@ public static OpenApiResponse GetResponse(this string statusCode, OpenApiDocumen
         /// </summary>
         /// <param name="context">The OData context.</param>
         /// <param name="document">The OpenApi document to lookup references.</param>
-        /// <returns>The name/value pairs for the standard OData error response.</returns>
-        public static IDictionary<string, OpenApiResponse> CreateResponses(this ODataContext context, OpenApiDocument document)
+        public static void AddResponsesToDocument(this ODataContext context, OpenApiDocument document)
         {
             Utils.CheckArgumentNull(context, nameof(context));
+            Utils.CheckArgumentNull(document, nameof(document));
 
             var responses =  new Dictionary<string, OpenApiResponse>
             {
@@ -101,7 +101,10 @@ public static IDictionary<string, OpenApiResponse> CreateResponses(this ODataCon
                     responses[$"{operation.Name}Response"] = response;
             }
 
-            return responses;
+            foreach (var response in responses)
+            {
+                document.AddComponent(response.Key, response.Value);
+            }
         }
 
         /// <summary>

test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiRequestBodyGeneratorTests.cs

@@ -163,9 +163,11 @@ public void CreateRefRequestBodies()
         {
             // Arrange
             ODataContext context = new ODataContext(_model);
+            OpenApiDocument openApiDocument = new OpenApiDocument();
 
             // Act
-            var requestBodies = context.CreateRequestBodies(new());
+            context.AddRequestBodiesToDocument(openApiDocument);
+            var requestBodies = openApiDocument.Components.RequestBodies;
             requestBodies.TryGetValue(Common.Constants.ReferencePostRequestBodyName, out Models.OpenApiRequestBody refPostBody);
 
             // Assert

test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiResponseGeneratorTests.cs

@@ -13,6 +13,7 @@
 using Microsoft.OpenApi.OData.Edm;
 using System.Text.Json.Nodes;
 using System.Threading.Tasks;
+using Moq;
 
 namespace Microsoft.OpenApi.OData.Generator.Tests
 {
@@ -48,9 +49,11 @@ public void CreateResponsesThrowArgumentNullContext()
         {
             // Arrange
             ODataContext context = null;
+            var mockModel = new Mock<IEdmModel>().Object;
 
             // Act & Assert
-            Assert.Throws<ArgumentNullException>("context", () => context.CreateResponses(new()));
+            Assert.Throws<ArgumentNullException>("context", () => context.AddResponsesToDocument(new()));
+            Assert.Throws<ArgumentNullException>("document", () => new ODataContext(mockModel).AddResponsesToDocument(null));
         }
 
         [Fact]
@@ -64,9 +67,11 @@ public void CreatesCollectionResponses()
                     EnablePagination = true,
             };
             ODataContext context = new(model, settings);
+            OpenApiDocument document = new();
 
             // Act & Assert
-            var responses = context.CreateResponses(new());
+            context.AddResponsesToDocument(document);
+            var responses = document.Components.Responses;
 
             var flightCollectionResponse = responses["Microsoft.OData.Service.Sample.TrippinInMemory.Models.FlightCollectionResponse"];
             var stringCollectionResponse = responses["StringCollectionResponse"];
@@ -81,9 +86,11 @@ public void CreateResponsesReturnsCreatedResponses()
             // Arrange
             IEdmModel model = EdmCoreModel.Instance;
             ODataContext context = new ODataContext(model);
+            OpenApiDocument document = new();
 
             // Act
-            var responses = context.CreateResponses(new());
+            context.AddResponsesToDocument(document);
+            var responses = document.Components.Responses;
 
             // Assert
             Assert.NotNull(responses);
@@ -101,9 +108,11 @@ public async Task CanSerializeAsJsonFromTheCreatedResponses()
             // Arrange
             IEdmModel model = EdmCoreModel.Instance;
             ODataContext context = new ODataContext(model);
+            OpenApiDocument document = new();
 
             // Act
-            var responses = context.CreateResponses(new());
+            context.AddResponsesToDocument(document);
+            var responses = document.Components.Responses;
 
             // Assert
             var response = responses["error"];