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

updated bullet point formatting as gitlab clobbered newlines

Browse Source
This commit is contained in:
shockrah 2020-05-25 13:51:47 -07:00
parent 1cb95cb59e
commit bcff4f02a7
1 changed files with 27 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/api.md
View File

@ -13,28 +13,35 @@ Authenticated routes require a session key which this route provides, given a pr
```
Parameters:
- id
User id provided by the instance
- secret
API key provided by the instance
* id
User id provided by the instance
* secret
API key provided by the instance
Return:
- api-key
Binary string base64 encoded. This encoding is not to be undone or further authentication _will_ fail.
- expiration
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`.
* api-key
Binary string base64 encoded. This encoding is not to be undone or further authentication _will_ fail.
* expiration
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
Parameters
- id
User id provided by the instance
- secret
API key provided by the instance
* id
User id provided by the instance
* secret
API key provided by the instance
Return:
On success: A simple HTTP 200 response; empty body.
On failure: An HTTP 400 Bad Request response; which parameter is wrong is not specified to avoid enumeration style attacks.
* On success: A simple HTTP 200 response; empty body.
* On failure: An HTTP 400 Bad Request response; which parameter is wrong is not specified to avoid enumeration style attacks.
## Channels
@ -59,16 +66,19 @@ Return:
```
Parameters:
- from::UnixTimestamp<u64>
* from::UnixTimestamp<u64>
DateTime from which to pull messages. Max value on this route can be no more than 72 hours in the past. To pull further messages you will need to use the `/message/range` route.
```
/message/range
```
Parameters:
- start::UnixTimestamp<u64>
- end::UnixTimestamp<u64>
* start::UnixTimestamp<u64>
* end::UnixTimestamp<u64>
On this route instances by default allow up to 1 week worth of range. Note of course that the closer a client gets to this maximum the longer it will take to load. Some instances may be configured to only return a certain number of messages as well so it is worthwhile to check the bounds of the messages a client receives.