aslan/nexlink
SHA256
1
0
Fork 0
Code Issues 26 Pull requests Projects 1 Releases Packages Wiki Activity Actions

Doc wording

Browse source
This commit is contained in:
Aslan 2025-12-22 21:59:34 -05:00
parent 1b024e31bb
commit 2f30eb62ef
2 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/api/auth.md
View file

@ -1,5 +1,5 @@
## POST /api/v1/register ## POST /api/v1/register
### Body: ### Request:
```json ```json
{ {
"username": "string", "username": "string",
@ -10,7 +10,7 @@
Registers a new user Registers a new user
### Returns (success): ### Response (success):
```json ```json
{ {
"username": "string", "username": "string",
@ -18,7 +18,7 @@ Registers a new user
} }
``` ```
### Returns (error): ### Response (error):
```json ```json
{ {
"error": "user already exists" "error": "user already exists"
@ -28,7 +28,7 @@ Registers a new user
--- ---
## POST /api/v1/login ## POST /api/v1/login
### Body: ### Request:
```json ```json
{ {
"username": "string", "username": "string",
@ -38,7 +38,7 @@ Registers a new user
Logs in a user and returns a new session Logs in a user and returns a new session
### Returns (success): ### Response (success):
```json ```json
{ {
"owner": "string", "owner": "string",
@ -46,7 +46,7 @@ Logs in a user and returns a new session
} }
``` ```
### Returns (incorrect credentials): ### Response (incorrect credentials):
```json ```json
{ {
"owner": "string", "owner": "string",

2
docs/api/user.md
View file

@ -1,7 +1,7 @@
## GET /api/v1/user/{id} ## GET /api/v1/user/{id}
Returns a user object with id = {id} Returns a user object with id = {id}
### Returns: ### Response:
```json ```json
{ {
"id": "string", "id": "string",