docs/admin_api.md: add draft for upcoming endpoints

This commit is contained in:
Luna 2019-03-16 16:00:21 -03:00
parent 681dee4306
commit 76048f3abc
1 changed files with 37 additions and 0 deletions

View File

@ -2,6 +2,43 @@
the base path is `/api/v6/admin`.
## User management
### `PUT /users`
Create a user.
Returns a user object.
| field | type | description |
| --: | :-- | :-- |
| username | string | username |
| email | email | the email of the new user |
| password | str | password for the new user |
### `GET /users`
Search users.
**TODO: query args**
### `DELETE /users/<user_id>`
**TODO**
## Instance invites
### `GET /instance/invites`
**TODO**
### `PUT /instance/invites`
**TODO**
### `DELETE /instance/invites/<invite>`
**TODO**
## Voice
### GET `/voice/regions/<region>`