From e444adeb7f8e220f9a0c40e090370b7af49629f4 Mon Sep 17 00:00:00 2001
From: Omar Roth <omarroth@protonmail.com>
Date: Fri, 12 Jul 2019 22:27:38 -0500
Subject: [PATCH] Add `/api/v1/channels/comments/:ucid`

---
 API.md | 110 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 110 insertions(+)

diff --git a/API.md b/API.md
index 4e2f4e6..1a14324 100644
--- a/API.md
+++ b/API.md
@@ -560,6 +560,99 @@ continuation: String
 sort_by: "oldest", "newest", "last"
 ```
 
+##### GET `/api/v1/channels/comments/:ucid`, `/api/v1/channels/:ucid/comments`
+
+
+```javascript
+{
+  "authorId": String,
+  "comments": [
+    {
+      "author": String,
+      "authorThumbnails": [
+        "url": String,
+        "width": Int32,
+        "height": Int32
+      ],
+      "authorId": String,
+      "authorUrl": String,
+      "isEdited": Bool,
+      "content": String,
+      "contentHtml": String,
+      "published": Int64,
+      "publishedText": String,
+      "likeCount": Int32,
+      "commentId": String,
+      "authorIsChannelOwner": Bool,
+      "creatorHeart": {
+        "creatorThumbnail": String,
+        "creatorName": String
+      }?,
+      "replies": {
+        "replyCount": Int32,
+        "continuation": String
+      }?,
+      "attachment": Attachment?
+    }
+  ],
+  "continuation": String?
+}
+```
+
+The `authorId` for top-level comments will always(?) be the same as the requested channel. Top-level comments will also have an optional `attachment`, which can be one of:
+
+```javascript
+{
+    "type": "image",
+    "imageThumbnails": [
+        {
+            "url": String,
+            "width": Int32,
+            "height": Int32
+        }
+    ]
+}
+```
+
+```javascript
+{
+    "type": "video",
+    "title": String,
+    "videoId": String,
+    "videoThumbnails": [
+        {
+            "quality": String,
+            "url": String,
+            "width": Int32,
+            "height": Int32
+        }
+    ],
+    "lengthSeconds": Int32,
+    "author": String,
+    "authorId": String,
+    "authorUrl": String,
+    "published": Int64,
+    "publishedText": String,
+    "viewCount": Int64,
+    "viewCountText": String
+}
+```
+
+```javascript
+{
+    "type": "unknown",
+    "error": "Unrecognized attachment type."
+}
+```
+
+Some attachments may only have a `type` and `error`, similar to the above. Attachments will *only* be present on top-level comments.
+
+Parameters:
+
+```
+continuation: String
+```
+
 ##### GET `/api/v1/channels/search/:ucid`
 
 > Schema:
@@ -644,6 +737,23 @@ q: String
 page: Int32
 ```
 
+##### GET `/api/v1/search/suggestions`
+
+> Schema:
+
+```javascript
+{
+    "query": String,
+    "suggestions": Array(String)
+}
+```
+
+Parameters:
+
+```
+q: String
+```
+
 ##### GET `/api/v1/search`
 
 > Schema: