Added inline documentation + fixed small bugs
This commit is contained in:
@@ -8,9 +8,18 @@ public interface IAuthLogic {
|
||||
|
||||
Task<LogicResult<SingleValueResult<string>>> Register(UserRegister register);
|
||||
|
||||
/// <summary>
|
||||
/// Reassures that the user has a valid refresh token and generates a new access token
|
||||
/// </summary>
|
||||
/// <returns>The newly generated access token</returns>
|
||||
Task<LogicResult<SingleValueResult<string>>> Authenticate();
|
||||
|
||||
Task<LogicResult> Logout();
|
||||
|
||||
/// <summary>
|
||||
/// Deletes the user account that called the endpoint if the provided password is correct
|
||||
/// </summary>
|
||||
/// <param name="validation">The password od the user</param>
|
||||
/// <returns></returns>
|
||||
Task<LogicResult> Delete(UserPasswordValidation validation);
|
||||
}
|
||||
@@ -1,5 +1,10 @@
|
||||
namespace HopFrame.Api.Models;
|
||||
|
||||
/// <summary>
|
||||
/// Useful for endpoints that only return a single int or string
|
||||
/// </summary>
|
||||
/// <param name="value">The value of the result</param>
|
||||
/// <typeparam name="TValue">The type of the result</typeparam>
|
||||
public struct SingleValueResult<TValue>(TValue value) {
|
||||
public TValue Value { get; set; } = value;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user