Doc wording
This commit is contained in:
parent
1b024e31bb
commit
2f30eb62ef
2 changed files with 7 additions and 7 deletions
|
|
@ -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",
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
## GET /api/v1/user/{id}
|
||||
Returns a user object with id = {id}
|
||||
|
||||
### Returns:
|
||||
### Response:
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue