absc
/
dudeswave2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Corrected module documentation.

main
absc 2024-08-07 22:19:11 +00:00
parent ceea61c1ed
commit 318ab0d301
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
dudeswave/src/dudeswave_user_handler.erl
View File

@ -20,7 +20,7 @@ JSON API to manage users.
The username should be passed as the last token in the request, like: 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. Where `foo` is the actual username.
@ -35,14 +35,14 @@ is returned.
This module accepts four methods: 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 Retrieve user's details. However, this call requires the user to have
a valid cookie set. Not suitable for a public page. 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. 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, Remove a user forever. The data is delete immediately. However,
it's content is left up there. Probably a specific option will be added 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 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 for the simple reason that we may make the call asynchronous
to remove additional content in background. to remove additional content in background.
- PUT /user/:username - PUT /api/v1/user/:username
Register a user. The registration takes only three parameter: username, Register a user. The registration takes only three parameter: username,
password and e-mail. The e-mail is required if a confirmation message 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 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 JSON APIs
GET /user/:username GET /api/v1/user/:username
``` ```
{ {
@ -74,7 +74,7 @@ Response codes:
- 200 OK (Success) - 200 OK (Success)
- 404 Not Found - 404 Not Found
PUT /user/:username PUT /api/v1/user/:username
``` ```
{ {
@ -89,7 +89,7 @@ Response codes:
- 400 Bad Request - 400 Bad Request
- 409 Conflict (User already exists) - 409 Conflict (User already exists)
POST /user/:username POST /api/v1/user/:username
``` ```
{ {
@ -105,7 +105,7 @@ Response codes:
- 400 Bad Request - 400 Bad Request
- 404 Not Found - 404 Not Found
DELETE /user/:username DELETE /api/v1/user/:username
- 202 Accepted - 202 Accepted
- 404 Not Found - 404 Not Found