(#48) Added proper request body linkage.

Author: Adrian Hall

src/CommunityToolkit.Datasync.Server.OpenApi/DatasyncOperationTransformer.cs

@@ -52,6 +52,12 @@ public async Task TransformAsync(OpenApiOperation operation, OpenApiOperationTra
             return;
         }
 
+        if (actionName?.StartsWith("Replace", StringComparison.InvariantCultureIgnoreCase) == true)
+        {
+            await TransformReplaceAsync(operation, context, cancellationToken).ConfigureAwait(false);
+            return;
+        }
+
         return;
     }
 
@@ -101,10 +107,15 @@ internal Task TransformCreateAsync(OpenApiOperation operation, OpenApiOperationT
     {
         Type entityType = GetEntityType(context);
 
-        operation.Responses.AddEntityResponse(201, context.GetSchemaForType(entityType), includeConditionalHeaders: true);
+        operation.AddRequestBody(context.GetSchemaForType(entityType));
+
+        operation.Responses.AddEntityResponse(StatusCodes.Status201Created,
+            context.GetSchemaForType(entityType), includeConditionalHeaders: true);
         operation.Responses.AddStatusCode(StatusCodes.Status400BadRequest);
-        operation.Responses.AddEntityResponse(409, context.GetSchemaForType(entityType), includeConditionalHeaders: true);
-        operation.Responses.AddEntityResponse(412, context.GetSchemaForType(entityType), includeConditionalHeaders: true);
+        operation.Responses.AddEntityResponse(StatusCodes.Status409Conflict,
+            context.GetSchemaForType(entityType), includeConditionalHeaders: true);
+        operation.Responses.AddEntityResponse(StatusCodes.Status412PreconditionFailed,
+            context.GetSchemaForType(entityType), includeConditionalHeaders: true);
 
         return Task.CompletedTask;
     }
@@ -126,9 +137,10 @@ internal Task TransformDeleteAsync(OpenApiOperation operation, OpenApiOperationT
         operation.Responses.AddStatusCode(StatusCodes.Status400BadRequest);
         operation.Responses.AddStatusCode(StatusCodes.Status404NotFound);
         operation.Responses.AddStatusCode(StatusCodes.Status410Gone);
-
-        operation.Responses.AddEntityResponse(409, context.GetSchemaForType(entityType), includeConditionalHeaders: true);
-        operation.Responses.AddEntityResponse(412, context.GetSchemaForType(entityType), includeConditionalHeaders: true);
+        operation.Responses.AddEntityResponse(StatusCodes.Status409Conflict,
+            context.GetSchemaForType(entityType), includeConditionalHeaders: true);
+        operation.Responses.AddEntityResponse(StatusCodes.Status412PreconditionFailed,
+            context.GetSchemaForType(entityType), includeConditionalHeaders: true);
 
         return Task.CompletedTask;
     }
@@ -153,7 +165,8 @@ internal Task TransformQueryAsync(OpenApiOperation operation, OpenApiOperationTr
         operation.Parameters.AddIntQueryParameter("$top", "The number of items to return", 1);
         operation.Parameters.AddIncludeDeletedQuery();
 
-        operation.Responses.AddEntityResponse(200, context.GetSchemaForType(pagedEntityType), includeConditionalHeaders: false);
+        operation.Responses.AddEntityResponse(StatusCodes.Status200OK,
+            context.GetSchemaForType(pagedEntityType), includeConditionalHeaders: false);
         operation.Responses.AddStatusCode(StatusCodes.Status400BadRequest);
 
         return Task.CompletedTask;
@@ -174,11 +187,41 @@ internal Task TransformReadAsync(OpenApiOperation operation, OpenApiOperationTra
         operation.Parameters.AddIfNoneMatchHeader();
         operation.Parameters.AddIfModifiedSinceHeader();
 
-        operation.Responses.AddEntityResponse(200, context.GetSchemaForType(entityType), includeConditionalHeaders: true);
+        operation.Responses.AddEntityResponse(StatusCodes.Status200OK,
+            context.GetSchemaForType(entityType), includeConditionalHeaders: true);
         operation.Responses.AddStatusCode(StatusCodes.Status304NotModified);
         operation.Responses.AddStatusCode(StatusCodes.Status404NotFound);
         operation.Responses.AddStatusCode(StatusCodes.Status410Gone);
 
         return Task.CompletedTask;
     }
+
+    /// <summary>
+    /// Transforms a replace operation.
+    /// </summary>
+    /// <param name="operation">The operation to transform.</param>
+    /// <param name="context">The operation transformer context.</param>
+    /// <param name="cancellationToken">A cancellation token to observe.</param>
+    /// <returns>A task that resolves when the operation is complete.</returns>
+    internal Task TransformReplaceAsync(OpenApiOperation operation, OpenApiOperationTransformerContext context, CancellationToken cancellationToken)
+    {
+        Type entityType = GetEntityType(context);
+
+        operation.AddRequestBody(context.GetSchemaForType(entityType));
+        operation.Parameters.AddIncludeDeletedQuery();
+        operation.Parameters.AddIfMatchHeader();
+        operation.Parameters.AddIfUnmodifiedSinceHeader();
+
+        operation.Responses.AddEntityResponse(StatusCodes.Status200OK,
+            context.GetSchemaForType(entityType), includeConditionalHeaders: true);
+        operation.Responses.AddStatusCode(StatusCodes.Status400BadRequest);
+        operation.Responses.AddStatusCode(StatusCodes.Status404NotFound);
+        operation.Responses.AddStatusCode(StatusCodes.Status410Gone);
+        operation.Responses.AddEntityResponse(StatusCodes.Status409Conflict,
+            context.GetSchemaForType(entityType), includeConditionalHeaders: true);
+        operation.Responses.AddEntityResponse(StatusCodes.Status412PreconditionFailed,
+            context.GetSchemaForType(entityType), includeConditionalHeaders: true);
+
+        return Task.CompletedTask;
+    }
 }

src/CommunityToolkit.Datasync.Server.OpenApi/InternalExtensions.cs

@@ -2,15 +2,11 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
-using Microsoft.AspNetCore.Mvc.RazorPages.Infrastructure;
 using Microsoft.AspNetCore.OpenApi;
 using Microsoft.AspNetCore.WebUtilities;
-using Microsoft.Extensions.DependencyInjection;
 using Microsoft.OpenApi.Any;
-using Microsoft.OpenApi.Extensions;
 using Microsoft.OpenApi.Models;
-using System.Reflection;
-using System.Transactions;
+using System.Net.Mime;
 
 namespace CommunityToolkit.Datasync.Server.OpenApi;
 
@@ -19,25 +15,21 @@ namespace CommunityToolkit.Datasync.Server.OpenApi;
 /// </summary>
 internal static class InternalExtensions
 {
-    private static readonly List<Type> openapiPrimitiveTypes = [
-        typeof(bool),
-        typeof(byte),
-        typeof(int),
-        typeof(uint),
-        typeof(long),
-        typeof(ulong),
-        typeof(short),
-        typeof(ushort),
-        typeof(float),
-        typeof(double),
-        typeof(decimal),
-        typeof(char),
-        typeof(string),
-        typeof(DateTime),
-        typeof(DateTimeOffset),
-        typeof(Guid),
-        typeof(Uri)
-    ];
+    /// <summary>
+    /// Adds a request body to the operation.
+    /// </summary>
+    /// <param name="operation">The operation to modify.</param>
+    /// <param name="bodySchema">The schema for the entity in the body.</param>
+    internal static void AddRequestBody(this OpenApiOperation operation, OpenApiSchema bodySchema)
+    {
+        operation.RequestBody ??= new OpenApiRequestBody();
+        operation.RequestBody.Content.Add(MediaTypeNames.Application.Json, new OpenApiMediaType
+        {
+            Schema = bodySchema
+        });
+        operation.RequestBody.Description = "The entity to process.";
+        operation.RequestBody.Required = true;
+    }
 
     /// <summary>
     /// Adds a boolean query parameter to the operation parameters.