hj/pleroma
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge branch 'chore/merge-search-into-list-users' into 'develop'

Browse source 
Merge search endpoint into /users

See merge request pleroma/pleroma!898
This commit is contained in:
kaniini 2019-03-06 22:27:42 +00:00
commit 0fe715f3ba
5 changed files with 89 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

35
docs/Admin-API.md
View file

@ -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