Add docs to /users/search

2019-03-01 17:34:14 +03:00 · 2019-03-01 17:34:14 +03:00 · adac745512
parent 46f29b9da1
commit adac745512
1 changed files with 20 additions and 0 deletions
--- a/docs/Admin-API.md
+++ b/docs/Admin-API.md
@ -20,6 +20,26 @@ Authentication is required and the user must be an admin.
 ]
 ```

+## `/api/pleroma/admin/users/search?query={query}`
+
+### Search users
+
+- Method `GET`
+- Params:
+  - `query`
+- Response:
+
+```JSON
+[
+    {
+        "deactivated": bool,
+        "id": integer,
+        "nickname": string
+    },
+    ...
+]
+```
+
 ## `/api/pleroma/admin/user`

 ### Remove a user