shockrah/freechat
shockrah/freechat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

moved structures secction to its own .md + sub sectioned everything to fit into a greater sub context in the full docs

Browse Source
This commit is contained in:
shockrahwow 2020-05-25 13:38:24 -07:00
parent b29f9d6934
commit ec25992578
1 changed files with 6 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/api.md
View File

@ -1,10 +1,10 @@
# Preface # API
Voice connections are not yet authored as they are far from being implemented 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 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`. 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 Parameters
- id - 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. 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 /channels/list/voice
@ -52,7 +52,7 @@ Return:
Return: Return:
List of struct::Members in that given channel List of struct::Members in that given channel
# Messaging ## Messaging
``` ```
/message/recent/<channel> /message/recent/<channel>
@ -81,32 +81,3 @@ On paramter failure:
On server error: On server error:
HTTP 500 Internal 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<u64>
}
Badge {
name: string
permissions: u64
color: u32
}
```