From bd2c77fbb60b3683e5ac871bad9a572e28ba5185 Mon Sep 17 00:00:00 2001 From: nodemixaholic Date: Thu, 7 Mar 2024 19:40:07 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 18eb708..edcc703 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,10 @@ https://example.com/harmonychat-api/v1 (so the BasePath is "/harmonychat-api/v1" * /common-details/get?detailType="friendsOrChannels"&unameOrServerID="tux"&passwd="usersPassword" - Get list of channels for server or friends. Passwd is not needed for the case of listing server channels, as demonstrated here, but *is* needed for listing a persons friends with friendship IDs next to them (Example `tux - ${randomizedFriendshipID}`). * /common-details/create?detailType="friendsOrChannels"&serverIdOrUname="tux"&selfPasswd="usersPassword"&friendUsernameOrChannelName="penny" - creates a random friendship/channel ID (friendship and channel IDs are interchangeable in the API), freindship/channel same for the friend username and self username if "friendUsernameOrChannelName" is a person's username. if it's actually a channel name, add the channel named with the nammed passed through "friendUsernameOrChannelName" to the server "serverIdOrUname" but only if it's a valid server and the user credentials match those of the a server admin. +/common-details/add?detailType="server"&serverId="tux's igloo"&uname="penny"&selfPasswd="usersPassword" -### Server (guild) creation -* /server/create?serverName="tux's igloo"&uname="tux"&passwd="usersPassword" - Creates server with random server ID and server name of the serverName variable, sets the first admin in the admins dictionary to a username (tux) and a password (usersPassword, as always this should be encoded on the server side, replacing usersPassword with the deencoded password!) \ No newline at end of file +### Server (guild) creation and administration. + +* /server/create?serverName="tux's igloo"&uname="tux"&passwd="usersPassword" - Creates server with random server ID and server name of the serverName variable, sets the first admin in the admins dictionary to a username (tux) and a password (usersPassword, as always this should be encoded on the server side, replacing usersPassword with the deencoded password!) +* /server/manage?taskName="makeAdmin"&targetAdminUname="penny"&serverName="tux's igloo"&selfUname="tux"&passwd="usersPassword" \ No newline at end of file