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

New smol note regarding state of API server

Browse Source
This commit is contained in:
shockrah 2020-05-27 20:59:17 -07:00
parent cc22a56538
commit 4e61ddbe11
1 changed files with 8 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
server/readme.md
View File

@ -1,18 +1,11 @@
# API
# Freechat API
This api operates on a per instance/world basis ergo we only concern ourselves with the same concerns as a typical server.
Built with rocket this API lets client apps query the server for data like recent messages
channels in a server.
# Language
* Instance/World/Realm are going to be used interchangably
# Endpoints::World
* auth - verifies a user is in fact part of that instance/world in some way
* register - base for creating a new user registered through this domain
* unlist - remove user from that domain's registry
* join - adds user to a member registry in that world; for users that come from other hubs
# What's Being worked on
Authorization model has been implemented and is now being integrated with endpoints
where required.
Not all endpoints require authentication but really those are more like exceptions
rather than the rule as most of this API is behind some kind of authentication.