From 163c9c25a9465adabebc2e4ae556261f6310ccd8 Mon Sep 17 00:00:00 2001 From: Jan Philipp Timme Date: Sat, 14 Sep 2013 23:35:50 +0200 Subject: [PATCH] [MISC] Add NOTES file containing ideas for api and document structure. --- NOTES | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 NOTES diff --git a/NOTES b/NOTES new file mode 100644 index 0000000..f390728 --- /dev/null +++ b/NOTES @@ -0,0 +1,38 @@ +Development notes + +user document: +{ + "_id": "%NICKNAME%", + "auth": "%SCRYPTHASH%", + "email": "%USERMAIL%", + "type": "user", + "profile": "%COUCHDOCID_PROFILE%" +} + +profile document: +{ + "_id": "%COUCHDOCID%", + "type": "profile", + "foo": "bar" +} + +--- + +API: + + +GET /user get user data +PUT /user create user +POST /user update user +DELETE /user delete user + + +GET /profile retrieve stored profile +PUT /profile set whole profile +POST /profile update given parts of profile +DELETE /profile prune profile data + + +PUT /session create session with given credentials +GET /session get session data +DELETE /session destroy session (logout) \ No newline at end of file