summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDessalines <happydooby@gmail.com>2019-05-15 09:21:10 -0700
committerDessalines <happydooby@gmail.com>2019-05-15 09:21:10 -0700
commit6b87cdcb63e53a759181574a56794f2fe74a91dd (patch)
treed33410df4647d1921007d1c0041a2fd3749f66fe
parentad661961fc3ce824b71c8359254a52a18b06a98a (diff)
Adding sort types to API.
-rw-r--r--docs/api.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md
index a3b459b5..69229c16 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -30,6 +30,9 @@ A simple test command:
### List
`Login, Register, CreateCommunity, CreatePost, ListCommunities, ListCategories, GetPost, GetCommunity, CreateComment, EditComment, SaveComment, CreateCommentLike, GetPosts, CreatePostLike, EditPost, SavePost, EditCommunity, FollowCommunity, GetFollowedCommunities, GetUserDetails, GetReplies, GetModlog, BanFromCommunity, AddModToCommunity, CreateSite, EditSite, GetSite, AddAdmin, BanUser, Search, MarkAllAsRead`
+### Sort Types
+`Hot, New, TopDay, TopWeek, TopMonth, TopYear, TopAll`
+
### User / Authentication / Admin
#### Login
The `jwt` string should be stored and used anywhere `auth` is called for.
@@ -540,6 +543,8 @@ Mods and admins can remove and lock a community, creators can delete it.
```
#### Get Posts
+`Post listing types are `All, Subscribed, Community`
+
##### Request
```rust
{