From e34710b9888d5a3602971111c3a376bf8442fb84 Mon Sep 17 00:00:00 2001
From: Maxim Filippov <colixer@gmail.com>
Date: Mon, 4 Mar 2019 21:33:53 +0300
Subject: Format & update docs

---
 docs/Admin-API.md | 35 +++++------------------------------
 1 file changed, 5 insertions(+), 30 deletions(-)

(limited to 'docs/Admin-API.md')

diff --git a/docs/Admin-API.md b/docs/Admin-API.md
index 407647645..7f60b768a 100644
--- a/docs/Admin-API.md
+++ b/docs/Admin-API.md
@@ -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
-- 
cgit v1.2.3


From 02359d686ca5f7feb1b83d77a35118bd55efdb52 Mon Sep 17 00:00:00 2001
From: Maxim Filippov <colixer@gmail.com>
Date: Mon, 4 Mar 2019 21:36:47 +0300
Subject: local -> only_local

---
 docs/Admin-API.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'docs/Admin-API.md')

diff --git a/docs/Admin-API.md b/docs/Admin-API.md
index 7f60b768a..24944440a 100644
--- a/docs/Admin-API.md
+++ b/docs/Admin-API.md
@@ -2,14 +2,14 @@
 
 Authentication is required and the user must be an admin.
 
-## `/api/pleroma/admin/users?query={query}&local={local}&page={page}&page_size={page_size}`
+## `/api/pleroma/admin/users?query={query}&only_local={only_local}&page={page}&page_size={page_size}`
 
 ### List users
 
 - Method `GET`
 - Params:
   - `query`: **string** *optional* search term
-  - `local`: **bool** *optional* whether to return only local users
+  - `only_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:
-- 
cgit v1.2.3


From 2d30fc279f2a3a5af68918c32c474a2fe8eaf664 Mon Sep 17 00:00:00 2001
From: Maxim Filippov <colixer@gmail.com>
Date: Tue, 5 Mar 2019 02:11:15 +0300
Subject: Typo

---
 docs/Admin-API.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/Admin-API.md')

diff --git a/docs/Admin-API.md b/docs/Admin-API.md
index 24944440a..64e112f9b 100644
--- a/docs/Admin-API.md
+++ b/docs/Admin-API.md
@@ -9,7 +9,7 @@ Authentication is required and the user must be an admin.
 - Method `GET`
 - Params:
   - `query`: **string** *optional* search term
-  - `only_local`: **bool** *optional* whether to return only local users
+  - `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:
-- 
cgit v1.2.3


From 76160122f6d7bf52aee929328acb4d216e4c3504 Mon Sep 17 00:00:00 2001
From: Maxim Filippov <colixer@gmail.com>
Date: Wed, 6 Mar 2019 05:01:38 +0300
Subject: Keep heading short

---
 docs/Admin-API.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'docs/Admin-API.md')

diff --git a/docs/Admin-API.md b/docs/Admin-API.md
index 64e112f9b..2edb31f3c 100644
--- a/docs/Admin-API.md
+++ b/docs/Admin-API.md
@@ -2,12 +2,12 @@
 
 Authentication is required and the user must be an admin.
 
-## `/api/pleroma/admin/users?query={query}&only_local={only_local}&page={page}&page_size={page_size}`
+## `/api/pleroma/admin/users`
 
 ### List users
 
 - Method `GET`
-- Params:
+- Query Params:
   - `query`: **string** *optional* search term
   - `local_only`: **bool** *optional* whether to return only local users
   - `page`: **integer** *optional* page number
-- 
cgit v1.2.3