Format & update docs
authorMaxim Filippov <colixer@gmail.com>
Mon, 4 Mar 2019 18:33:53 +0000 (21:33 +0300)
committerMaxim Filippov <colixer@gmail.com>
Mon, 4 Mar 2019 18:33:53 +0000 (21:33 +0300)
docs/Admin-API.md
test/web/admin_api/admin_api_controller_test.exs

index 407647645655a2db461007f177a3253ff4f42991..7f60b768acdc49409d621137130be3d933502666 100644 (file)
@@ -2,41 +2,16 @@
 
 Authentication is required and the user must be an admin.
 
-## `/api/pleroma/admin/users`
+## `/api/pleroma/admin/users?query={query}&local={local}&page={page}&page_size={page_size}`
 
 ### 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`: **string** *optional* search term
+  - `local`: **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
index dd40b4a06d6c0082f24ea6f09efd19f104ab752d..1b8b4d4b78b1209d91206681d3b3223506a0169f 100644 (file)
@@ -476,11 +476,11 @@ defmodule Pleroma.Web.AdminAPI.AdminAPIControllerTest do
                "count" => 2,
                "page_size" => 50,
                "users" => [
-                %{
-                  "deactivated" => admin.info.deactivated,
-                  "id" => admin.id,
-                  "nickname" => admin.nickname
-                },
+                 %{
+                   "deactivated" => admin.info.deactivated,
+                   "id" => admin.id,
+                   "nickname" => admin.nickname
+                 },
                  %{
                    "deactivated" => user.info.deactivated,
                    "id" => user.id,