rough api docs

apidocs.txt

@@ -0,0 +1,179 @@
+base: /api/v3
+
+*** /logs ***
+
+GET /
+- url encoded
+- requires login/token
+- admin only
+> type (stdout/stderr/apilog) - this will change
+> limit (def: 20, max: 50)
+> page (start: 0, depends on limit)
+
+*** /users ***
+
+creates account on first login to dashboard
+on account deletion, logs you out as well
+
+POST /
+- json encoded
+- requires login/token
+- admin only
+
+GET /@me
+- json encoded
+- requires login/token
+
+PUT /@me
+- json encoded
+- requires login/token
+
+PATCH /@me
+- json encoded
+- requires login/token
+
+DELETE /@me
+- json encoded
+- requires login/token
+
+GET /:discord_id
+- json encoded
+- requires login/token
+- admin only
+
+PUT /:discord_id
+- json encoded
+- requires login/token
+- admin only
+
+PATCH /:discord_id
+- json encoded
+- requires login/token
+- admin only
+
+DELETE /:discord_id
+- json encoded
+- requires login/token
+- admin only
+
+*** /scripts ***
+
+GET /
+- url encoded
+- requires login/token
+> local
+> name
+> type
+> permissions
+> match
+> match_type
+> limit (def: 10, max: 25)
+> page (start: 0, depends on limit)
+
+POST /
+- json encoded
+- requires login/token
+- admin only
+- does not add the script to your account
+
+GET /@me - needs pagination
+- json encoded
+- requires login/token
+
+POST /@me
+- json encoded
+- requires login/token
+
+GET /@me/:object_id
+- json encoded
+- requires login/token
+
+PUT /@me/:object_id
+- json encoded
+- requires login/token
+
+PATCH /@me/:object_id
+- json encoded
+- requires login/token
+
+DELETE /@me/:object_id
+- json encoded
+- requires login/token
+- deletes script from your account
+
+GET /:object_id
+- json encoded
+- requires login/token
+- admin only
+
+PUT /:object_id
+- json encoded
+- requires login/token
+- admin only
+
+PATCH /:object_id
+- json encoded
+- requires login/token
+- admin only
+
+DELETE /:object_id
+- json encoded
+- requires login/token
+- admin only
+- removes all traces of the script
+
+*** /guilds ***
+
+creates a guild doc when awesomo is added to a server
+
+POST /
+- json encoded
+- requires login/token
+- admin only
+
+GET /@me - needs pagination
+- json encoded
+- requires login/token
+- needs admin server perms
+
+GET /@me/:discord_id
+- json encoded
+- requires login/token
+- needs admin server perms
+
+PUT /@me/:discord_id
+- json encoded
+- requires login/token
+- needs admin server perms
+
+PATCH /@me/:discord_id
+- json encoded
+- requires login/token
+- needs admin server perms
+
+DELETE /@me/:discord_id
+- json encoded
+- requires login/token
+- needs admin server perms
+- removes awesomo from the server
+
+GET /:discord_id
+- json encoded
+- requires login/token
+- admin only
+
+PUT /:discord_id
+- json encoded
+- requires login/token
+- admin only
+
+PATCH /:discord_id
+- json encoded
+- requires login/token
+- admin only
+
+DELETE /:discord_id
+- json encoded
+- requires login/token
+- admin only
+- removes awesomo from the server