Add more objects
This commit is contained in:
parent
2f30eb62ef
commit
cea0a001b8
6 changed files with 158 additions and 3 deletions
65
docs/api/community.md
Normal file
65
docs/api/community.md
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
## GET /api/v1/community/{id}
|
||||
*Requires authentication header*
|
||||
Returns a community with id = {id}
|
||||
|
||||
### Response:
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
"name": "string"
|
||||
}
|
||||
```
|
||||
|
||||
## GET /api/v1/community/{id}/members
|
||||
*Requires authentication header*
|
||||
Returns users for a community with id = {id}
|
||||
|
||||
### Response:
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
"name": "string",
|
||||
"members": [
|
||||
{
|
||||
"id": "string",
|
||||
"username": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## GET /api/v1/community/{id}/channels
|
||||
*Requires authentication header*
|
||||
Returns channels for a community with id = {id}
|
||||
|
||||
### Response:
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
"name": "string",
|
||||
"channels": [
|
||||
{
|
||||
"id": "string",
|
||||
"name": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## GET /api/v1/community/{id}/roles
|
||||
*Requires authentication header*
|
||||
Returns roles for a community with id = {id}
|
||||
|
||||
### Response:
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
"name": "string",
|
||||
"roles": [
|
||||
{
|
||||
"id": "string",
|
||||
"name": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue