diff --git a/dudeswave/src/dudeswave_user_handler.erl b/dudeswave/src/dudeswave_user_handler.erl index 8e1a144..09d5a11 100644 --- a/dudeswave/src/dudeswave_user_handler.erl +++ b/dudeswave/src/dudeswave_user_handler.erl @@ -20,7 +20,7 @@ JSON API to manage users. The username should be passed as the last token in the request, like: ``` -/user/foo +/api/v1/user/foo ``` Where `foo` is the actual username. @@ -35,14 +35,14 @@ is returned. This module accepts four methods: -- GET /user/:username +- GET /api/v1/user/:username Retrieve user's details. However, this call requires the user to have a valid cookie set. Not suitable for a public page. -- POST /user/:username +- POST /api/v1/user/:username Update user's details, like their name, description and whatnot. -- DELETE /user/:username +- DELETE /api/v1/user/:username Remove a user forever. The data is delete immediately. However, it's content is left up there. Probably a specific option will be added later. This request does not have a body. The call deletes the user @@ -50,7 +50,7 @@ This module accepts four methods: for the simple reason that we may make the call asynchronous to remove additional content in background. -- PUT /user/:username +- PUT /api/v1/user/:username Register a user. The registration takes only three parameter: username, password and e-mail. The e-mail is required if a confirmation message is to be sent. The plan is to have a separate process handle this, so the @@ -58,7 +58,7 @@ This module accepts four methods: JSON APIs -GET /user/:username +GET /api/v1/user/:username ``` { @@ -74,7 +74,7 @@ Response codes: - 200 OK (Success) - 404 Not Found -PUT /user/:username +PUT /api/v1/user/:username ``` { @@ -89,7 +89,7 @@ Response codes: - 400 Bad Request - 409 Conflict (User already exists) -POST /user/:username +POST /api/v1/user/:username ``` { @@ -105,7 +105,7 @@ Response codes: - 400 Bad Request - 404 Not Found -DELETE /user/:username +DELETE /api/v1/user/:username - 202 Accepted - 404 Not Found