forked from AkkomaGang/akkoma
Format & update docs
This commit is contained in:
parent
f620199836
commit
e34710b988
2 changed files with 10 additions and 35 deletions
|
@ -2,41 +2,16 @@
|
||||||
|
|
||||||
Authentication is required and the user must be an admin.
|
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
|
### List users
|
||||||
|
|
||||||
- Method `GET`
|
- Method `GET`
|
||||||
- Params:
|
- Params:
|
||||||
- `page`: **integer** page number
|
- `query`: **string** *optional* search term
|
||||||
- `page_size`: **integer** number of users per page (default is `50`)
|
- `local`: **bool** *optional* whether to return only local users
|
||||||
- Response:
|
- `page`: **integer** *optional* page number
|
||||||
|
- `page_size`: **integer** *optional* number of users per page (default is `50`)
|
||||||
```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`)
|
|
||||||
- Response:
|
- Response:
|
||||||
|
|
||||||
```JSON
|
```JSON
|
||||||
|
|
|
@ -476,11 +476,11 @@ test "only local users with no query" do
|
||||||
"count" => 2,
|
"count" => 2,
|
||||||
"page_size" => 50,
|
"page_size" => 50,
|
||||||
"users" => [
|
"users" => [
|
||||||
%{
|
%{
|
||||||
"deactivated" => admin.info.deactivated,
|
"deactivated" => admin.info.deactivated,
|
||||||
"id" => admin.id,
|
"id" => admin.id,
|
||||||
"nickname" => admin.nickname
|
"nickname" => admin.nickname
|
||||||
},
|
},
|
||||||
%{
|
%{
|
||||||
"deactivated" => user.info.deactivated,
|
"deactivated" => user.info.deactivated,
|
||||||
"id" => user.id,
|
"id" => user.id,
|
||||||
|
|
Loading…
Reference in a new issue