summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDessalines <happydooby@gmail.com>2019-08-13 19:52:43 -0700
committerDessalines <happydooby@gmail.com>2019-08-13 19:52:43 -0700
commit70628d89c0b0e0fb4694b57a3657d49eb26abb54 (patch)
tree37fd5d0f5117cb5cf07ba7e233f3734d65deadd6 /docs
parentc148eefc1df3eda124246691f62cc7ecfe2d3558 (diff)
Squashed commit of the following:
commit 309d3ec01fb2372e67920cdd7b028c0b80c4ebe6 Author: Dessalines <happydooby@gmail.com> Date: Tue Aug 13 19:49:38 2019 -0700 Adding some docs commit da18d304377c96e31a511b11b1a4cf1d0b0f0ab7 Author: Dessalines <happydooby@gmail.com> Date: Tue Aug 13 19:28:46 2019 -0700 Adding save user settings commit 0cd84440f4b35dbc7d7fa825291c783114b327c9 Merge: 3246d5d c148eef Author: Dessalines <happydooby@gmail.com> Date: Tue Aug 13 17:26:25 2019 -0700 Merge branch 'dev' into nsfw commit 3246d5d670d0d5e10310a90c6fd81a7dc9e97e54 Author: Dessalines <happydooby@gmail.com> Date: Sun Aug 11 20:55:09 2019 -0700 nsfw mostly done, except for settings page.
Diffstat (limited to 'docs')
-rw-r--r--docs/api.md18
1 files changed, 16 insertions, 2 deletions
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