From 3fb134b1d27a0c1069f14dc2608f25295e85eaa9 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/TokenController.cs | 38 +++++++++++++++++++++++++++++----
 1 file changed, 34 insertions(+), 4 deletions(-)

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

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