diff --git a/docs/api/auth.md b/docs/api/auth.md index be67bac..75d5d40 100644 --- a/docs/api/auth.md +++ b/docs/api/auth.md @@ -1,5 +1,5 @@ ## POST /api/v1/register -### Body: +### Request: ```json { "username": "string", @@ -10,7 +10,7 @@ Registers a new user -### Returns (success): +### Response (success): ```json { "username": "string", @@ -18,7 +18,7 @@ Registers a new user } ``` -### Returns (error): +### Response (error): ```json { "error": "user already exists" @@ -28,7 +28,7 @@ Registers a new user --- ## POST /api/v1/login -### Body: +### Request: ```json { "username": "string", @@ -38,7 +38,7 @@ Registers a new user Logs in a user and returns a new session -### Returns (success): +### Response (success): ```json { "owner": "string", @@ -46,7 +46,7 @@ Logs in a user and returns a new session } ``` -### Returns (incorrect credentials): +### Response (incorrect credentials): ```json { "owner": "string", diff --git a/docs/api/user.md b/docs/api/user.md index 53eac68..e0deecb 100644 --- a/docs/api/user.md +++ b/docs/api/user.md @@ -1,7 +1,7 @@ ## GET /api/v1/user/{id} Returns a user object with id = {id} -### Returns: +### Response: ```json { "id": "string",