From 32fdf425e6b4f4edfb727fb3c0cbebe2c87fd663 Mon Sep 17 00:00:00 2001
From: crupest <crupest@outlook.com>
Date: Thu, 20 Aug 2020 00:39:09 +0800
Subject: ...

---
 Timeline/Models/Http/UserController.cs | 47 ++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

(limited to 'Timeline/Models/Http/UserController.cs')

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);
-- 
cgit v1.2.3