[MISC] Update development notes.

This commit is contained in:
Jan Philipp Timme 2013-09-15 13:45:00 +02:00
parent 03e66dfc83
commit f63afa6c10
1 changed files with 21 additions and 16 deletions

37
NOTES
View File

@ -1,4 +1,5 @@
Development notes Development notes
------------------
user document: user document:
{ {
@ -13,26 +14,30 @@ profile document:
{ {
"_id": "%COUCHDOCID%", "_id": "%COUCHDOCID%",
"type": "profile", "type": "profile",
"foo": "bar" "data": {
//the object that is handled
}
} }
--- API
----
API: GET retrieve data
PUT put a whole dataset (overwrite)
POST update a dataset (update given parts only)
DELETE delete/destroy something
GET /user get user data GET /user {} {success, user: {%USER_DOCUMENT%}}
PUT /user create user PUT /user {username, password, email} {success}
POST /user update user POST /user {username, password, email} {success}
DELETE /user delete user DELETE /user {username, password} {success}
GET /profile {} {success, profile: {%PROFILE_DOCUMENT}}
PUT /profile {profile} {success}
POST /profile {profile} {success}
DELETE /profile {} {success}
GET /profile retrieve stored profile GET /session {} {success, login}
PUT /profile set whole profile PUT /session {username, password} {success}
POST /profile update given parts of profile DELETE /session {} {success}
DELETE /profile prune profile data
PUT /session create session with given credentials
GET /session get session data
DELETE /session destroy session (logout)