velvox
/
litecord
mirror of https://gitlab.com/litecord/litecord.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs/admin_api.md: update headings

This commit is contained in:
Luna 2019-03-15 16:09:52 -03:00
parent b90089a784
commit 30be092c3c
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/admin_api.md
View File

@ -2,7 +2,9 @@
the base path is `/api/v6/admin`. the base path is `/api/v6/admin`.
## GET `/voice/regions/<region>` ## Voice
### GET `/voice/regions/<region>`
Return a list of voice server objects for the region. Return a list of voice server objects for the region.
@ -13,7 +15,7 @@ Returns empty list if the region does not exist.
| hostname | string | the hostname of the voice server | | hostname | string | the hostname of the voice server |
| last\_health | float | the health of the voice server | | last\_health | float | the health of the voice server |
## PUT `/voice/regions` ### PUT `/voice/regions`
Create a voice region. Create a voice region.
@ -27,7 +29,7 @@ Receives JSON body as input, returns a list of voice region objects as output.
| deprecated | Optional[bool] | if voice region is deprecated, default false | | deprecated | Optional[bool] | if voice region is deprecated, default false |
| custom | Optional[bool] | if voice region is custom-only, default false | | custom | Optional[bool] | if voice region is custom-only, default false |
## PUT `/voice/regions/<region>/server` ### PUT `/voice/regions/<region>/server`
Create a voice server for a region. Create a voice server for a region.
@ -37,7 +39,7 @@ Returns empty body with 204 status code on success.
| --: | :-- | :-- | | --: | :-- | :-- |
| hostname | string | the hostname of the voice server | | hostname | string | the hostname of the voice server |
## PUT `/voice/regions/<region>/deprecate` ### PUT `/voice/regions/<region>/deprecate`
Mark a voice region as deprecated. Disables any voice actions on guilds that are Mark a voice region as deprecated. Disables any voice actions on guilds that are
using the voice region. using the voice region.