From 4e61ddbe113c55e716d857c216fafd9a6f3bd0f4 Mon Sep 17 00:00:00 2001 From: shockrah Date: Wed, 27 May 2020 20:59:17 -0700 Subject: [PATCH] New smol note regarding state of API server --- server/readme.md | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) diff --git a/server/readme.md b/server/readme.md index 6eb3474..9d17813 100644 --- a/server/readme.md +++ b/server/readme.md @@ -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. \ No newline at end of file