diff options
author | Dessalines <happydooby@gmail.com> | 2019-08-13 19:49:38 -0700 |
---|---|---|
committer | Dessalines <happydooby@gmail.com> | 2019-08-13 19:49:38 -0700 |
commit | 309d3ec01fb2372e67920cdd7b028c0b80c4ebe6 (patch) | |
tree | 37fd5d0f5117cb5cf07ba7e233f3734d65deadd6 | |
parent | da18d304377c96e31a511b11b1a4cf1d0b0f0ab7 (diff) |
Adding some docs
-rw-r--r-- | README.md | 1 | ||||
-rw-r--r-- | docs/api.md | 18 |
2 files changed, 17 insertions, 2 deletions
@@ -37,6 +37,7 @@ Front Page|Post - Can ban and unban users from communities and the site. - Clean, mobile-friendly interface. - i18n / internationalization support. +- NSFW post / community support. - High performance. - Server is written in rust. - Front end is `~80kB` gzipped. diff --git a/docs/api.md b/docs/api.md index 744de5f3..90b931e6 100644 --- a/docs/api.md +++ b/docs/api.md @@ -28,7 +28,7 @@ A simple test command: ## API ### 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` +`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, SaveUserSettings` ### Sort Types These go wherever there is a `sort` field. @@ -109,7 +109,21 @@ Only the first user will be able to be the admin. posts: Vec<PostView>, } ``` - +#### Save User Settings +##### Request +```rust +{ + show_nsfw: bool, + auth: String, +} +``` +##### Response +```rust +{ + op: String, + jwt: String +} +``` #### Get Replies / Inbox ##### Request ```rust |