AaronPo/the-biergarten-app
1
0
Fork 0
mirror of https://github.com/aaronpo97/the-biergarten-app.git synced 2026-10-15 01:54:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

update backend/shared docs

Browse Source
This commit is contained in:
Aaron Po
2026-08-04 06:19:10 -04:00
parent 64302286fb
commit 7a0620337d
2 changed files with 4 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
web/backend/Shared/Shared.Contracts/ResponseBody.cs
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; }
}