match readme to changed response for user's comments

2018-01-15 13:32:18 -06:00
parent 4e6a15ad99
commit b8ded408ff
1 changed files with 8 additions and 2 deletions
@@ -170,10 +170,16 @@ Sort can be `time` or `score`. Supported sort order with prefix -/+, i.e. `-time

 - `GET /api/v1/last/{max}?site=site-id` - get up to `{max}` last comments
 - `GET /api/v1/id/{id}?site=site-id` - get comment by `comment id`
- `GET /api/v1/comments?site=site-id&user=id` - get comment by `user id`
+- `GET /api/v1/comments?site=site-id&user=id` - get comment by `user id`, returns `response` object
+    ```go
+    type response struct {
+    	Comments []store.Comment  `json:"comments"`
+    	Count    int              `json:"count"`
+    }{}
+    ```
 - `GET /api/v1/count?site=site-id&url=post-url` - get comment's count for `{url}`
 - `GET /api/v1/list?site=site-id` - list commented posts, returns array or `PostInfo`
-    ```
+    ```go
    type PostInfo struct {
 	    URL   string `json:"url"`
 	    Count int    `json:"count"`