aboutsummaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorrr-2016-04-24 11:24:52 +0200
committerrr-2016-04-24 11:56:14 +0200
commit0b47957bb9032fd021c35e8e42c2dd2029915358 (patch)
treea651b2b0bff546df75afcea3df6867c9d3b486b5 /API.md
parentb75cfff8f7ca05840cdbf6308cbd2aa0a8e173ae (diff)
server/comments: add comment search
Diffstat (limited to 'API.md')
-rw-r--r--API.md71
1 files changed, 70 insertions, 1 deletions
diff --git a/API.md b/API.md
index 4dd6d72..fe097cc 100644
--- a/API.md
+++ b/API.md
@@ -39,7 +39,7 @@
- [Getting featured post](#getting-featured-post)
- [Featuring post](#featuring-post)
- Comments
- - ~~Listing comments~~
+ - [Listing comments](#listing-comments)
- [Creating comment](#creating-comment)
- [Updating comment](#updating-comment)
- [Getting comment](#getting-comment)
@@ -673,6 +673,75 @@ data.
Features a post on the main page in web client.
+## Listing comments
+- **Request**
+
+ `GET /comments/?page=<page>&pageSize=<page-size>&query=<query>`
+
+- **Output**
+
+ ```json5
+ {
+ "query": <query>, // same as in input
+ "page": <page>, // same as in input
+ "pageSize": <page-size>,
+ "total": <total-count>,
+ "comments": [
+ <comment>,
+ <comment>,
+ <comment>
+ ]
+ }
+ ```
+ ...where `<comment>` is a [comment resource](#comment) and `query` contains
+ standard [search query](#search).
+
+- **Errors**
+
+ - privileges are too low
+
+- **Description**
+
+ Searches for comments.
+
+ **Anonymous tokens**
+
+ Same as `text` token.
+
+ **Named tokens**
+
+ | `<value>` | Description |
+ | ---------------- | ---------------------------------------------- |
+ | `id` | specific comment ID |
+ | `post` | specific post ID |
+ | `user` | created by given user (accepts wildcards) |
+ | `text` | containing given text (accepts wildcards) |
+ | `creation-date` | created at given date |
+ | `creation-time` | alias of `creation-date` |
+ | `last-edit-date` | whose most recent edit date matches given date |
+ | `last-edit-time` | alias of `last-edit-date` |
+ | `edit-date` | alias of `last-edit-date` |
+ | `edit-time` | alias of `last-edit-date` |
+
+ **Sort style tokens**
+
+ | `<value>` | Description |
+ | ---------------- | ------------------------- |
+ | `random` | as random as it can get |
+ | `user` | author name, A to Z |
+ | `post` | post ID, newest to oldest |
+ | `creation-date` | newest to oldest |
+ | `creation-time` | alias of `creation-date` |
+ | `last-edit-date` | recently edited first |
+ | `last-edit-time` | alias of `last-edit-date` |
+ | `edit-date` | alias of `last-edit-date` |
+ | `edit-time` | alias of `last-edit-date` |
+
+ **Special tokens**
+
+ None.
+
+
## Creating comment
- **Request**

© 2015 - 2026 Jakob L. Kreuze