summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlex Gleason <alex@alexgleason.me>2021-12-19 17:31:17 +0000
committerAlex Gleason <alex@alexgleason.me>2021-12-19 17:31:17 +0000
commitbd853199d93e03fedf43397455939c6d633fa36b (patch)
tree43f9ba6643d7d75da506954c35cc39af7f4e1d2c /docs
parent7c1d804554cd361753f4d6f2d0ac27a9281c885f (diff)
parent6519f59d91d858273f929dc1c2a36752f6db07a9 (diff)
Merge branch 'v2-suggestions' into 'develop'
V2 suggestions See merge request pleroma/pleroma!3547
Diffstat (limited to 'docs')
-rw-r--r--docs/development/API/admin_api.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/development/API/admin_api.md b/docs/development/API/admin_api.md
index 82483fae7..f14081893 100644
--- a/docs/development/API/admin_api.md
+++ b/docs/development/API/admin_api.md
@@ -261,6 +261,46 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
}
```
+## `PATCH /api/v1/pleroma/admin/users/suggest`
+
+### Suggest a user
+
+Adds the user(s) to follower recommendations.
+
+- Params:
+ - `nicknames`: nicknames array
+- Response:
+
+```json
+{
+ users: [
+ {
+ // user object
+ }
+ ]
+}
+```
+
+## `PATCH /api/v1/pleroma/admin/users/unsuggest`
+
+### Unsuggest a user
+
+Removes the user(s) from follower recommendations.
+
+- Params:
+ - `nicknames`: nicknames array
+- Response:
+
+```json
+{
+ users: [
+ {
+ // user object
+ }
+ ]
+}
+```
+
## `GET /api/v1/pleroma/admin/users/:nickname_or_id`
### Retrive the details of a user