From 53868f2ed62c86a5a2b2f9d93d7cb40ef8654cc7 Mon Sep 17 00:00:00 2001 From: shockrah Date: Sun, 10 Nov 2019 16:31:32 -0800 Subject: [PATCH] docs for server-api --- server/Cargo.toml | 6 ++---- server/readme.md | 17 ++++++++++++++++- 2 files changed, 18 insertions(+), 5 deletions(-) diff --git a/server/Cargo.toml b/server/Cargo.toml index eb86507..b949adf 100644 --- a/server/Cargo.toml +++ b/server/Cargo.toml @@ -1,10 +1,8 @@ [package] -name = "api" +name = "freechat-api" version = "0.1.0" authors = ["shockrahwow "] -edition = "2018" - -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +edition = "2019" [dependencies] rocket = "0.4.2" diff --git a/server/readme.md b/server/readme.md index 24b2cb9..6eb3474 100644 --- a/server/readme.md +++ b/server/readme.md @@ -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 +