From f665df578cc493858861addfc7abbe70d0ccf73a Mon Sep 17 00:00:00 2001
From: Aaron Po <apo2@uwo.ca>
Date: Tue, 4 Aug 2026 06:19:10 -0400
Subject: [PATCH] update backend/shared docs

---
 .../Behaviors/ValidationBehavior.cs                |  5 ++---
 .../Shared/Shared.Contracts/ResponseBody.cs        | 14 ++------------
 2 files changed, 4 insertions(+), 15 deletions(-)

diff --git a/web/backend/Shared/Shared.Application/Behaviors/ValidationBehavior.cs b/web/backend/Shared/Shared.Application/Behaviors/ValidationBehavior.cs
index e41d152b..05a21fcb 100644
--- a/web/backend/Shared/Shared.Application/Behaviors/ValidationBehavior.cs
+++ b/web/backend/Shared/Shared.Application/Behaviors/ValidationBehavior.cs
@@ -5,9 +5,8 @@ using MediatR;
 namespace Shared.Application.Behaviors;
 
 /// <summary>
-///     MediatR pipeline behavior that runs all registered FluentValidation validators for a
-///     request before invoking its handler, short-circuiting with a <see cref="ValidationException" />
-///     when any validator reports failures.
+///     MediatR pipeline behavior that runs registered FluentValidation validators before the handler,
+///     throwing <see cref="ValidationException" /> if any report failures.
 /// </summary>
 public class ValidationBehavior<TRequest, TResponse>(IEnumerable<IValidator<TRequest>> validators)
     : IPipelineBehavior<TRequest, TResponse>
diff --git a/web/backend/Shared/Shared.Contracts/ResponseBody.cs b/web/backend/Shared/Shared.Contracts/ResponseBody.cs
index 4fc35c4f..2326814a 100644
--- a/web/backend/Shared/Shared.Contracts/ResponseBody.cs
+++ b/web/backend/Shared/Shared.Contracts/ResponseBody.cs
@@ -1,29 +1,19 @@
 namespace Shared.Contracts;
 
 /// <summary>
-///     Generic envelope used to wrap API responses that carry a data payload alongside a human-readable message.
+///     Generic envelope used to wrap API responses that carry a data payload alongside a message.
 /// </summary>
-/// <typeparam name="T">The type of the data payload returned in the response.</typeparam>
 public record ResponseBody<T>
 {
-    /// <summary>
-    ///     A human-readable message describing the outcome of the request.
-    /// </summary>
     public required string Message { get; init; }
 
-    /// <summary>
-    ///     The data payload associated with the response.
-    /// </summary>
     public required T Payload { get; init; }
 }
 
 /// <summary>
-///     Envelope used to wrap API responses that carry only a human-readable message and no data payload.
+///     Envelope used to wrap API responses that carry only a message and no data payload.
 /// </summary>
 public record ResponseBody
 {
-    /// <summary>
-    ///     A human-readable message describing the outcome of the request.
-    /// </summary>
     public required string Message { get; init; }
 }