dashboard/NOTES

43 lines
940 B
Plaintext

Development notes
------------------
user document:
{
"_id": "%NICKNAME%",
"auth": "%SCRYPTHASH%",
"email": "%USERMAIL%",
"type": "user",
"profile": "%COUCHDOCID_PROFILE%"
}
profile document:
{
"_id": "%COUCHDOCID%",
"type": "profile",
"data": {
//the object that is handled
}
}
API
----
GET retrieve data
PUT put a whole dataset (overwrite)
POST update a dataset (update given parts only)
DELETE delete/destroy something
GET /user {} {success, user: {%USER_DOCUMENT%}}
PUT /user {username, password, email} {success}
POST /user {username, password, email} {success}
DELETE /user {username, password} {success}
GET /profile {} {success, profile: {%PROFILE_DOCUMENT}}
PUT /profile {profile} {success}
POST /profile {profile} {success}
DELETE /profile {} {success}
GET /session {} {success, login}
PUT /session {username, password} {success}
DELETE /session {} {success}