Add docs to /users/search
authorMaxim Filippov <colixer@gmail.com>
Fri, 1 Mar 2019 14:34:14 +0000 (17:34 +0300)
committerMaxim Filippov <colixer@gmail.com>
Fri, 1 Mar 2019 14:34:14 +0000 (17:34 +0300)
docs/Admin-API.md

index 508981d38353fc2dc99185ca0f58ba290e5fe404..ed19bc875d698d47a1eb3044bb8f86f561e0ac00 100644 (file)
@@ -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