diff --git a/docs/api.md b/docs/api.md index d66f2ae..00e7eaa 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,10 +1,10 @@ -# Preface +# API Voice connections are not yet authored as they are far from being implemented -# Auth Routes +## Auth Routes -## Logging in +### Logging in Authenticated routes require a session key which this route provides, given a previously invited user's credentials @@ -25,7 +25,7 @@ Return: Unix time stamp dictating when this key should be deleted server side. Though the server may delete the key later than this time-stamp the client can request a new token via `/auth/login` or `/auth/refresh`. -## Leaving an instance +### Leaving an instance Parameters - id @@ -37,7 +37,7 @@ Return: On failure: An HTTP 400 Bad Request response; which parameter is wrong is not specified to avoid enumeration style attacks. -# Channels +## Channels ``` /channels/list/voice @@ -52,7 +52,7 @@ Return: Return: List of struct::Members in that given channel -# Messaging +## Messaging ``` /message/recent/ @@ -81,32 +81,3 @@ On paramter failure: On server error: HTTP 500 Internal Server Error -# Structures - -Below are various structures that client builds can expect to receive. - -``` -Member { - name: string - id: u64 - permissions: u64 -} - -Channel { - name: string - description: string - type: integer [1=Voice Channel, 2=Text Channel] -} - -Message { - content: string - author: Member - date: Unix Timestamp -} - -Badge { - name: string - permissions: u64 - color: u32 -} -```