update backend/shared docs

This commit is contained in:
Aaron Po
2026-08-04 06:19:10 -04:00
parent f9acdc8ada
commit f665df578c
2 changed files with 4 additions and 15 deletions

View File

@@ -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>

View File

@@ -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; }
}