diff options
| author | crupest <crupest@outlook.com> | 2020-08-21 23:47:10 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-21 23:47:10 +0800 |
| commit | c28848a35b0f31a59f9d02641571495822ad0db8 (patch) | |
| tree | 520b56d834185ba5f9f556558a181bb9f4059b29 /Timeline/Models/Http/TokenController.cs | |
| parent | 30e96fc5a59a8324ed861e7f7e856c44b4d329ff (diff) | |
| parent | 3aa8e1cda4222fc3a9828888ba8fb51d2ba1d6c8 (diff) | |
| download | timeline-c28848a35b0f31a59f9d02641571495822ad0db8.tar.gz timeline-c28848a35b0f31a59f9d02641571495822ad0db8.tar.bz2 timeline-c28848a35b0f31a59f9d02641571495822ad0db8.zip | |
Merge pull request #149 from crupest/swagger
Swagger/OpenAPI
Diffstat (limited to 'Timeline/Models/Http/TokenController.cs')
| -rw-r--r-- | Timeline/Models/Http/TokenController.cs | 38 |
1 files changed, 34 insertions, 4 deletions
diff --git a/Timeline/Models/Http/TokenController.cs b/Timeline/Models/Http/TokenController.cs index ea8b59ed..a42c44e5 100644 --- a/Timeline/Models/Http/TokenController.cs +++ b/Timeline/Models/Http/TokenController.cs @@ -1,32 +1,62 @@ using System.ComponentModel.DataAnnotations;
+using Timeline.Controllers;
namespace Timeline.Models.Http
{
+ /// <summary>
+ /// Request model for <see cref="TokenController.Create(CreateTokenRequest)"/>.
+ /// </summary>
public class CreateTokenRequest
{
- [Required]
+ /// <summary>
+ /// The username.
+ /// </summary>
public string Username { get; set; } = default!;
- [Required]
+ /// <summary>
+ /// The password.
+ /// </summary>
public string Password { get; set; } = default!;
- // in days, optional
+ /// <summary>
+ /// Optional token validation period. In days. If not specified, server will use a default one.
+ /// </summary>
[Range(1, 365)]
public int? Expire { get; set; }
}
+ /// <summary>
+ /// Response model for <see cref="TokenController.Create(CreateTokenRequest)"/>.
+ /// </summary>
public class CreateTokenResponse
{
+ /// <summary>
+ /// The token created.
+ /// </summary>
public string Token { get; set; } = default!;
+ /// <summary>
+ /// The user owning the token.
+ /// </summary>
public UserInfo User { get; set; } = default!;
}
+ /// <summary>
+ /// Request model for <see cref="TokenController.Verify(VerifyTokenRequest)"/>.
+ /// </summary>
public class VerifyTokenRequest
{
- [Required]
+ /// <summary>
+ /// The token to verify.
+ /// </summary>
public string Token { get; set; } = default!;
}
+ /// <summary>
+ /// Response model for <see cref="TokenController.Verify(VerifyTokenRequest)"/>.
+ /// </summary>
public class VerifyTokenResponse
{
+ /// <summary>
+ /// The user owning the token.
+ /// </summary>
public UserInfo User { get; set; } = default!;
}
}
|