Browse Source

Transferring blueprint from apiary.io

master
Julio Biason 11 years ago
parent
commit
04e829c4d2
  1. 16
      apiary.apib

16
apiary.apib

@ -1,5 +1,5 @@
FORMAT: 1A FORMAT: 1A
HOST: http://luncho.io/ HOST: http://pospichil.com/luncho/
# Lunch-o # Lunch-o
Lunching for Groups. Lunching for Groups.
@ -54,12 +54,12 @@ forbidden to create new groups. They can still vote, though.
{ "status": "ERROR", "error": "username already exists" } { "status": "ERROR", "error": "username already exists" }
## Single User [/user/{token}/] ## Single User [/user/{username}/]
Manage a single user. Manage a single user.
+ Parameters + Parameters
+ token ... The user token + username ... Username used in the creation process.
### Update information [POST] ### Update information [POST]
@ -69,7 +69,7 @@ change will require only the "token" and "password" fields.
+ Request (application/json) + Request (application/json)
{ "full_name": "Full name", "password": "hash" } { "token": "userToken", "full_name": "Full name", "password": "hash" }
+ Response 200 (application/json) + Response 200 (application/json)
@ -79,14 +79,18 @@ change will require only the "token" and "password" fields.
{ "status": "ERROR", "error": "Invalid token" } { "status": "ERROR", "error": "Invalid token" }
+ Response 404 (application/json) + Response 401 (application/json)
{ "status": "ERROR", "error": "User not found (via token)"} { "status": "ERROR", "error": "User is not admin or not the same user" }
### Remove user [DELETE] ### Remove user [DELETE]
User removal is only allowed to the user themselves or by a system admin. User removal is only allowed to the user themselves or by a system admin.
+ Request (application/json)
{ "token": "userToken" }
+ Response 200 (application/json) + Response 200 (application/json)
{ "status": "OK" } { "status": "OK" }

Loading…
Cancel
Save