summaryrefslogtreecommitdiff
path: root/doc/API.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/API.md')
-rw-r--r--doc/API.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/API.md b/doc/API.md
index 3d280fd..63a50a2 100644
--- a/doc/API.md
+++ b/doc/API.md
@@ -37,6 +37,7 @@
- [Creating post](#creating-post)
- [Updating post](#updating-post)
- [Getting post](#getting-post)
+ - [Getting around post](#getting-around-post)
- [Deleting post](#deleting-post)
- [Merging posts](#merging-posts)
- [Rating post](#rating-post)
@@ -951,6 +952,29 @@ data.
Retrieves information about an existing post.
+## Getting around post
+- **Request**
+
+ `GET /post/<id>/around`
+
+- **Output**
+
+ ```json5
+ {
+ "prev": <post-resource>,
+ "next": <post-resource>
+ }
+ ```
+
+- **Errors**
+
+ - the post does not exist
+ - privileges are too low
+
+- **Description**
+
+ Retrieves information about posts that are before or after an existing post.
+
## Deleting post
- **Request**