Formatting; Creation dates
This commit is contained in:
parent
d1685fde77
commit
a85fc8a49d
7 changed files with 94 additions and 41 deletions
|
|
@ -1,21 +1,26 @@
|
|||
## GET /api/v1/community/{id}
|
||||
*Requires an authentication header*
|
||||
|
||||
_Requires an authentication header_
|
||||
|
||||
Returns a community with id = {id}
|
||||
|
||||
### Response:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
"name": "string",
|
||||
"description": "string"
|
||||
"description": "string",
|
||||
"creationDate": 0
|
||||
}
|
||||
```
|
||||
|
||||
## UPDATE /api/v1/community/{id}/name
|
||||
*Requires an authentication header*
|
||||
|
||||
_Requires an authentication header_
|
||||
|
||||
### Request:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "string"
|
||||
|
|
@ -25,17 +30,20 @@ Returns a community with id = {id}
|
|||
Updates name for a community with id = {id}
|
||||
|
||||
### Response:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
"name": "string",
|
||||
"name": "string"
|
||||
}
|
||||
```
|
||||
|
||||
## PATCH /api/v1/community/{id}/description
|
||||
*Requires an authentication header*
|
||||
|
||||
_Requires an authentication header_
|
||||
|
||||
### Request:
|
||||
|
||||
```json
|
||||
{
|
||||
"description": "string"
|
||||
|
|
@ -45,19 +53,22 @@ Updates name for a community with id = {id}
|
|||
Updates description for a community with id = {id}
|
||||
|
||||
### Response:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
"description": "string",
|
||||
"description": "string"
|
||||
}
|
||||
```
|
||||
|
||||
## GET /api/v1/community/{id}/members
|
||||
*Requires an authentication header*
|
||||
|
||||
_Requires an authentication header_
|
||||
|
||||
Returns users for a community with id = {id}
|
||||
|
||||
### Response:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
|
|
@ -72,11 +83,13 @@ Returns users for a community with id = {id}
|
|||
```
|
||||
|
||||
## GET /api/v1/community/{id}/channels
|
||||
*Requires an authentication header*
|
||||
|
||||
_Requires an authentication header_
|
||||
|
||||
Returns channels for a community with id = {id}
|
||||
|
||||
### Response:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
|
|
@ -91,11 +104,13 @@ Returns channels for a community with id = {id}
|
|||
```
|
||||
|
||||
## GET /api/v1/community/{id}/roles
|
||||
*Requires an authentication header*
|
||||
|
||||
_Requires an authentication header_
|
||||
|
||||
Returns roles for a community with id = {id}
|
||||
|
||||
### Response:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "string",
|
||||
|
|
@ -110,9 +125,11 @@ Returns roles for a community with id = {id}
|
|||
```
|
||||
|
||||
## POST /api/v1/community/{id}/invite
|
||||
*Requires an authentication header*
|
||||
|
||||
_Requires an authentication header_
|
||||
|
||||
### Request:
|
||||
|
||||
```json
|
||||
{
|
||||
"userId": "string"
|
||||
|
|
@ -122,20 +139,22 @@ Returns roles for a community with id = {id}
|
|||
Creates an invite to a community with id = {id}
|
||||
|
||||
### Response:
|
||||
|
||||
```json
|
||||
{
|
||||
"userId": "string",
|
||||
"userName": "string",
|
||||
"communityId": "string",
|
||||
"communityName": "string",
|
||||
"communityName": "string"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## POST /api/v1/community/{id}/join
|
||||
*Requires an authentication header*
|
||||
|
||||
_Requires an authentication header_
|
||||
|
||||
### Request:
|
||||
|
||||
```json
|
||||
{
|
||||
"userId": "string"
|
||||
|
|
@ -145,11 +164,12 @@ Creates an invite to a community with id = {id}
|
|||
Joins a user to a community with id = {id}
|
||||
|
||||
### Response:
|
||||
|
||||
```json
|
||||
{
|
||||
"userId": "string",
|
||||
"userName": "string",
|
||||
"communityId": "string",
|
||||
"communityName": "string",
|
||||
"communityName": "string"
|
||||
}
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue