[Credo] fix Credo.Check.Readability.AliasOrder

[akkoma] / docs / Admin-API.md

diff --git a/docs/Admin-API.md b/docs/Admin-API.md
index 407647645655a2db461007f177a3253ff4f42991..2edb31f3c2e71c6ac4b4a63083e386960c3cc80f 100644 (file)
--- a/docs/Admin-API.md
+++ b/docs/Admin-API.md
@@ -7,36 +7,11 @@ Authentication is required and the user must be an admin.
 ### List users
 
 - Method `GET`
-- Params:
-  - `page`: **integer** page number
-  - `page_size`: **integer** number of users per page (default is `50`)
-- Response:
-
-```JSON
-{
-  "page_size": integer,
-  "count": integer,
-  "users": [
-    {
-      "deactivated": bool,
-      "id": integer,
-      "nickname": string
-    },
-    ...
-  ]
-}
-```
-
-## `/api/pleroma/admin/users/search?query={query}&local={local}&page={page}&page_size={page_size}`
-
-### Search users by name or nickname
-
-- Method `GET`
-- Params:
-  - `query`: **string** search term
-  - `local`: **bool** whether to return only local users
-  - `page`: **integer** page number
-  - `page_size`: **integer** number of users per page (default is `50`)
+- Query Params:
+  - `query`: **string** *optional* search term
+  - `local_only`: **bool** *optional* whether to return only local users
+  - `page`: **integer** *optional* page number
+  - `page_size`: **integer** *optional* number of users per page (default is `50`)
 - Response:
 
 ```JSON