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

Formatting

Browse source
This commit is contained in:
Aslan 2025-12-23 14:47:12 -05:00
parent cea0a001b8
commit f2ecc61b78
5 changed files with 22 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/api/channel.md
View file

@ -1,5 +1,6 @@
## GET /api/v1/channel/{id} ## GET /api/v1/channel/{id}
*Requires authentication header* *Requires an authentication header*
Returns a channel with id = {id} Returns a channel with id = {id}
### Response: ### Response:

12
docs/api/community.md
View file

@ -1,5 +1,6 @@
## GET /api/v1/community/{id} ## GET /api/v1/community/{id}
*Requires authentication header* *Requires an authentication header*
Returns a community with id = {id} Returns a community with id = {id}
### Response: ### Response:
@ -11,7 +12,8 @@ Returns a community with id = {id}
``` ```
## GET /api/v1/community/{id}/members ## GET /api/v1/community/{id}/members
*Requires authentication header* *Requires an authentication header*
Returns users for a community with id = {id} Returns users for a community with id = {id}
### Response: ### Response:
@ -29,7 +31,8 @@ Returns users for a community with id = {id}
``` ```
## GET /api/v1/community/{id}/channels ## GET /api/v1/community/{id}/channels
*Requires authentication header* *Requires an authentication header*
Returns channels for a community with id = {id} Returns channels for a community with id = {id}
### Response: ### Response:
@ -47,7 +50,8 @@ Returns channels for a community with id = {id}
``` ```
## GET /api/v1/community/{id}/roles ## GET /api/v1/community/{id}/roles
*Requires authentication header* *Requires an authentication header*
Returns roles for a community with id = {id} Returns roles for a community with id = {id}
### Response: ### Response:

3
docs/api/role.md
View file

@ -1,5 +1,6 @@
## GET /api/v1/role/{id} ## GET /api/v1/role/{id}
*Requires authentication header* *Requires an authentication header*
Returns a role with id = {id} Returns a role with id = {id}
### Response: ### Response:

3
docs/api/session.md
View file

@ -1,5 +1,6 @@
## GET /api/v1/session/{id} ## GET /api/v1/session/{id}
*Requires authentication header* *Requires an authentication header*
Returns a session with id = {id} Returns a session with id = {id}
### Response: ### Response:

12
docs/api/user.md
View file

@ -1,5 +1,6 @@
## GET /api/v1/user/{id} ## GET /api/v1/user/{id}
*Requires authentication header* *Requires an authentication header*
Returns a user with id = {id} Returns a user with id = {id}
### Response: ### Response:
@ -16,7 +17,8 @@ Returns a user with id = {id}
``` ```
## GET /api/v1/user/{id}/sessions ## GET /api/v1/user/{id}/sessions
*Requires authentication header* *Requires an authentication header*
Returns all sessions for a user with id = {id} Returns all sessions for a user with id = {id}
### Response: ### Response:
@ -32,7 +34,8 @@ Returns all sessions for a user with id = {id}
``` ```
## POST /api/v1/user/{id}/email ## POST /api/v1/user/{id}/email
*Requires authentication header* *Requires an authentication header*
### Request: ### Request:
```json ```json
{ {
@ -51,7 +54,8 @@ Updates email for a user with id = {id}
``` ```
## POST /api/v1/user/{id}/description ## POST /api/v1/user/{id}/description
*Requires authentication header* *Requires an authentication header*
### Request: ### Request:
```json ```json
{ {