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

docs for server-api

Browse Source
This commit is contained in:
shockrah
2019-11-10 16:31:32 -08:00
parent b07234f114
commit 53868f2ed6
2 changed files with 18 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
server/readme.md
View File

@@ -1,3 +1,18 @@
# API
To serve clients data about the server they are joined into
This api operates on a per instance/world basis ergo we only concern ourselves with the same concerns as a typical 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