From ce79d33380b4538c7bd9cbd64d332263f64ed5b4 Mon Sep 17 00:00:00 2001 From: shockrah Date: Sat, 12 Dec 2020 15:45:13 -0800 Subject: [PATCH] Basically a rewrite of previous docs but this one is super terse --- server-api/endpoints.md | 42 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 server-api/endpoints.md diff --git a/server-api/endpoints.md b/server-api/endpoints.md new file mode 100644 index 0000000..5c928f9 --- /dev/null +++ b/server-api/endpoints.md @@ -0,0 +1,42 @@ +# Documenting the currently tested / working endpoints + +Mostly a dev reference for now since it's a lot more terse. + +## Parameters + +All parameters are to be passed in via json, other parameters are ignored + +## Auth + +Basically every endpoint except for `/join` and `/meta` require the folowing auth +data at a bare minimum. + +* id: u64 -> User id | Public data +* secret: String -> sever generated token to be used for endpoint authentication + +## Chat api + +`/channels/list` NoPermsRequired + +No parameters required + +`/channels/create` RequiredPerm[CREATE_CHANNEL=64] + +* @Required name: `String` + +* @Required kind: `Signed 32-bit Integer` + +* @Optional description: `String` + +For voice channel `1`. For text channel `2`. All other options result in a HTTP 400. + + +`/channels/delete` RequiredPerm[DELETE_CHANNEL=128] + +* @Required channel_id: `Unsigned 64-bit Integer` + +`/message/send` RequiredPerm[SEND_MESSAGES=2] + +* @Required channel `Unsigned 64-bit Integer` + +* @Required content `String`