From ecd6c5a2f47cbbb2fc4bf482fadd78380303a904 Mon Sep 17 00:00:00 2001 From: Dessalines Date: Tue, 13 Aug 2019 19:49:38 -0700 Subject: [PATCH] Adding some docs --- README.md | 1 + docs/api.md | 18 ++++++++++++++++-- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 295c436f..9862885c 100644 --- a/README.md +++ b/README.md @@ -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, } ``` - +#### Save User Settings +##### Request +```rust +{ + show_nsfw: bool, + auth: String, +} +``` +##### Response +```rust +{ + op: String, + jwt: String +} +``` #### Get Replies / Inbox ##### Request ```rust