diff options
| author | Luna <git@l4.pm> | 2022-06-08 20:06:09 -0300 |
|---|---|---|
| committer | Neo <50623835+neobooru@users.noreply.github.com> | 2022-06-10 01:49:07 +0200 |
| commit | 6c3b50d287a8b8ba67d2bb4cf3cffe25bcd3b4e6 (patch) | |
| tree | 6436d73b6d384346ab433b32a90236fa575ae5fa /doc | |
| parent | 6075ae9326b95fa8c863ca80abca040c6e0d6561 (diff) | |
doc: add GET /post/<id>/around to API.md
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/API.md | 24 |
1 files changed, 24 insertions, 0 deletions
@@ -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** |