doc: add GET /post/<id>/around to API.md
This commit is contained in:
parent
6075ae9326
commit
6c3b50d287
1 changed files with 24 additions and 0 deletions
24
doc/API.md
24
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**
|
||||
|
||||
|
|
Loading…
Reference in a new issue