From f1c70edd559c72dcb47ff647f3f03ba5ae9a56cc Mon Sep 17 00:00:00 2001
From: crupest <crupest@outlook.com>
Date: Fri, 21 Aug 2020 23:44:53 +0800
Subject: ...

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

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

diff --git a/Timeline/Models/Http/TimelineController.cs b/Timeline/Models/Http/TimelineController.cs
index 3e2e6b58..aad361ee 100644
--- a/Timeline/Models/Http/TimelineController.cs
+++ b/Timeline/Models/Http/TimelineController.cs
@@ -4,33 +4,66 @@ using Timeline.Models.Validation;
 
 namespace Timeline.Models.Http
 {
+    /// <summary>
+    /// Content of post create request.
+    /// </summary>
     public class TimelinePostCreateRequestContent
     {
+        /// <summary>
+        /// Type of post content.
+        /// </summary>
         [Required]
         public string Type { get; set; } = default!;
+        /// <summary>
+        /// If post is of text type, this is the text.
+        /// </summary>
         public string? Text { get; set; }
+        /// <summary>
+        /// If post is of image type, this is base64 of image data.
+        /// </summary>
         public string? Data { get; set; }
     }
 
     public class TimelinePostCreateRequest
     {
+        /// <summary>
+        /// Content of the new post.
+        /// </summary>
         [Required]
         public TimelinePostCreateRequestContent Content { get; set; } = default!;
 
+        /// <summary>
+        /// Time of the post. If not set, current time will be used.
+        /// </summary>
         public DateTime? Time { get; set; }
     }
 
+    /// <summary>
+    /// Create timeline request model.
+    /// </summary>
     public class TimelineCreateRequest
     {
+        /// <summary>
+        /// Name of the new timeline. Must be a valid name.
+        /// </summary>
         [Required]
         [TimelineName]
         public string Name { get; set; } = default!;
     }
 
+    /// <summary>
+    /// Patch timeline request model.
+    /// </summary>
     public class TimelinePatchRequest
     {
+        /// <summary>
+        /// New description. Null for not change.
+        /// </summary>
         public string? Description { get; set; }
 
+        /// <summary>
+        /// New visibility. Null for not change.
+        /// </summary>
         public TimelineVisibility? Visibility { get; set; }
     }
 }
-- 
cgit v1.2.3