summaryrefslogtreecommitdiff
path: root/docs/development/API/admin_api.md
diff options
context:
space:
mode:
authormarcin mikołajczak <git@mkljczk.pl>2021-12-25 00:52:02 +0100
committermarcin mikołajczak <git@mkljczk.pl>2021-12-25 00:52:02 +0100
commit9775955974171c19e2dd9e6930e96e33f25cb4db (patch)
tree498b0572f6edb8d09acb471b6b557de6ca9bc638 /docs/development/API/admin_api.md
parentcd5fb84b76a51fe6c7b5d672298a87c34737c303 (diff)
parent1fa616638b8823a6cc0d67d0354cc179da5943f8 (diff)
downloadpleroma-9775955974171c19e2dd9e6930e96e33f25cb4db.tar.gz
pleroma-9775955974171c19e2dd9e6930e96e33f25cb4db.zip
Merge remote-tracking branch 'origin/develop' into remote-follow-api
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
Diffstat (limited to 'docs/development/API/admin_api.md')
-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