[MISC] Add NOTES file containing ideas for api and document structure.

This commit is contained in:
Jan Philipp Timme 2013-09-14 23:35:50 +02:00
parent dc0a10b506
commit 163c9c25a9
1 changed files with 38 additions and 0 deletions

38
NOTES Normal file
View File

@ -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)