From 76048f3abce253705863a104d723a44e8b84fac9 Mon Sep 17 00:00:00 2001 From: Luna Date: Sat, 16 Mar 2019 16:00:21 -0300 Subject: [PATCH] docs/admin_api.md: add draft for upcoming endpoints --- docs/admin_api.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/docs/admin_api.md b/docs/admin_api.md index 4dc8863..ab28751 100644 --- a/docs/admin_api.md +++ b/docs/admin_api.md @@ -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/` + +**TODO** + +## Instance invites + +### `GET /instance/invites` + +**TODO** + +### `PUT /instance/invites` + +**TODO** + +### `DELETE /instance/invites/` + +**TODO** + ## Voice ### GET `/voice/regions/`