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 | 733b8291855d1498e0ba9bc36a47a1b5f8b612ad (patch) | |
| tree | 4885b9f7e828ec3f0ae7e2acacf348c9f5c158d9 /Timeline/Models/Http/UserController.cs | |
| parent | dc363ad8ae654af056c9ffa551008dbbf52b5d57 (diff) | |
| parent | f1c70edd559c72dcb47ff647f3f03ba5ae9a56cc (diff) | |
| download | timeline-733b8291855d1498e0ba9bc36a47a1b5f8b612ad.tar.gz timeline-733b8291855d1498e0ba9bc36a47a1b5f8b612ad.tar.bz2 timeline-733b8291855d1498e0ba9bc36a47a1b5f8b612ad.zip | |
Merge pull request #149 from crupest/swagger
Swagger/OpenAPI
Diffstat (limited to 'Timeline/Models/Http/UserController.cs')
| -rw-r--r-- | Timeline/Models/Http/UserController.cs | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/Timeline/Models/Http/UserController.cs b/Timeline/Models/Http/UserController.cs index 5ee02a95..6bc5a66e 100644 --- a/Timeline/Models/Http/UserController.cs +++ b/Timeline/Models/Http/UserController.cs @@ -1,42 +1,83 @@ 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!;
}
|