diff options
| author | crupest <crupest@outlook.com> | 2020-08-20 00:39:09 +0800 |
|---|---|---|
| committer | crupest <crupest@outlook.com> | 2020-08-20 00:39:09 +0800 |
| commit | 32fdf425e6b4f4edfb727fb3c0cbebe2c87fd663 (patch) | |
| tree | ba373b6b022d96cc0b3723d693296b42374ec465 /Timeline/Models/Http | |
| parent | 44b410f359f64e6cb69d506b5689d2b3df715c74 (diff) | |
| download | timeline-32fdf425e6b4f4edfb727fb3c0cbebe2c87fd663.tar.gz timeline-32fdf425e6b4f4edfb727fb3c0cbebe2c87fd663.tar.bz2 timeline-32fdf425e6b4f4edfb727fb3c0cbebe2c87fd663.zip | |
...
Diffstat (limited to 'Timeline/Models/Http')
| -rw-r--r-- | Timeline/Models/Http/Common.cs | 11 | ||||
| -rw-r--r-- | Timeline/Models/Http/TokenController.cs | 38 | ||||
| -rw-r--r-- | Timeline/Models/Http/UserController.cs | 47 |
3 files changed, 92 insertions, 4 deletions
diff --git a/Timeline/Models/Http/Common.cs b/Timeline/Models/Http/Common.cs index a9fc8a79..5fa22c9e 100644 --- a/Timeline/Models/Http/Common.cs +++ b/Timeline/Models/Http/Common.cs @@ -71,25 +71,36 @@ namespace Timeline.Models.Http }
}
+ /// <summary>
+ /// Common response for delete method.
+ /// </summary>
public class CommonDeleteResponse : CommonDataResponse<CommonDeleteResponse.ResponseData>
{
+ /// <summary></summary>
public class ResponseData
{
+ /// <summary></summary>
public ResponseData() { }
+ /// <summary></summary>
public ResponseData(bool delete)
{
Delete = delete;
}
+ /// <summary>
+ /// True if the entry is deleted. False if the entry does not exist.
+ /// </summary>
public bool Delete { get; set; }
}
+ /// <summary></summary>
public CommonDeleteResponse()
{
}
+ /// <summary></summary>
public CommonDeleteResponse(int code, string message, bool delete)
: base(code, message, new ResponseData(delete))
{
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!;
}
}
diff --git a/Timeline/Models/Http/UserController.cs b/Timeline/Models/Http/UserController.cs index 5ee02a95..ea30a0ea 100644 --- a/Timeline/Models/Http/UserController.cs +++ b/Timeline/Models/Http/UserController.cs @@ -1,48 +1,95 @@ using AutoMapper;
using System.ComponentModel.DataAnnotations;
+using Timeline.Controllers;
using Timeline.Models.Validation;
namespace Timeline.Models.Http
{
+ /// <summary>
+ /// Request model for <see cref="UserController.Patch(UserPatchRequest, string)"/>.
+ /// </summary>
public class UserPatchRequest
{
+ /// <summary>
+ /// New username. Null if not change. Need to be administrator.
+ /// </summary>
[Username]
public string? Username { get; set; }
+ /// <summary>
+ /// New password. Null if not change. Need to be administrator.
+ /// </summary>
[MinLength(1)]
public string? Password { get; set; }
+ /// <summary>
+ /// New nickname. Null if not change. Need to be administrator to change other's.
+ /// </summary>
[Nickname]
public string? Nickname { get; set; }
+ /// <summary>
+ /// Whether to be administrator. Null if not change. Need to be administrator.
+ /// </summary>
public bool? Administrator { get; set; }
}
+ /// <summary>
+ /// Request model for <see cref="UserController.CreateUser(CreateUserRequest)"/>.
+ /// </summary>
public class CreateUserRequest
{
+ /// <summary>
+ /// Username of the new user.
+ /// </summary>
[Required, Username]
public string Username { get; set; } = default!;
+ /// <summary>
+ /// Password of the new user.
+ /// </summary>
[Required, MinLength(1)]
public string Password { get; set; } = default!;
+ /// <summary>
+ /// Whether the new user is administrator.
+ /// </summary>
[Required]
public bool? Administrator { get; set; }
+ /// <summary>
+ /// Nickname of the new user.
+ /// </summary>
[Nickname]
public string? Nickname { get; set; }
}
+ /// <summary>
+ /// Request model for <see cref="UserController.ChangePassword(ChangePasswordRequest)"/>.
+ /// </summary>
public class ChangePasswordRequest
{
+ /// <summary>
+ /// Old password.
+ /// </summary>
[Required(AllowEmptyStrings = false)]
public string OldPassword { get; set; } = default!;
+
+ /// <summary>
+ /// New password.
+ /// </summary>
[Required(AllowEmptyStrings = false)]
public string NewPassword { get; set; } = default!;
}
+ /// <summary>
+ ///
+ /// </summary>
public class UserControllerAutoMapperProfile : Profile
{
+ /// <summary>
+ ///
+ /// </summary>
public UserControllerAutoMapperProfile()
{
CreateMap<UserPatchRequest, User>(MemberList.Source);
|