110 lines
1.5 KiB
Markdown
110 lines
1.5 KiB
Markdown
## GET /api/v1/channel/{id}
|
|
|
|
_Requires an authorization header_
|
|
|
|
Returns a channel with id = {id}
|
|
|
|
### Response:
|
|
|
|
```json
|
|
{
|
|
"id": "string",
|
|
"name": "string",
|
|
"description": "string",
|
|
"communityId": "string",
|
|
"creationDate": "number"
|
|
}
|
|
```
|
|
|
|
## POST /api/v1/channel
|
|
|
|
_Requires an authorization header_
|
|
|
|
### Request:
|
|
|
|
```json
|
|
{
|
|
"name": "string",
|
|
"communityId": "string"
|
|
}
|
|
```
|
|
|
|
Creates a new channel and returns it
|
|
|
|
### Response:
|
|
|
|
```json
|
|
{
|
|
"id": "string",
|
|
"name": "string",
|
|
"description": "string",
|
|
"communityId": "string",
|
|
"creationDate": "number"
|
|
}
|
|
```
|
|
|
|
## PATCH /api/v1/channel/{id}
|
|
|
|
_Requires an authorization header_
|
|
|
|
### Request:
|
|
|
|
```json
|
|
{
|
|
"name": "string?",
|
|
"description": "string?"
|
|
}
|
|
```
|
|
|
|
Updates a channel with id = {id}
|
|
|
|
### Response:
|
|
|
|
```json
|
|
{
|
|
"id": "string",
|
|
"name": "string",
|
|
"description": "string",
|
|
"communityId": "string",
|
|
"creationDate": "number"
|
|
}
|
|
```
|
|
|
|
## DELETE /api/v1/channel/{id}
|
|
|
|
_Requires an authorization header_
|
|
|
|
Removes a channel with id = {id}
|
|
|
|
### Response:
|
|
|
|
```json
|
|
{
|
|
"id": "string",
|
|
"communityId": "string"
|
|
}
|
|
```
|
|
|
|
## GET /api/v1/channel/{id}/messages
|
|
|
|
_Requires an authorization header_
|
|
|
|
Returns messages for a channel with id = {id}
|
|
|
|
### Response:
|
|
|
|
```json
|
|
{
|
|
"id": "string",
|
|
"name": "string",
|
|
"messages": [
|
|
{
|
|
"id": "string",
|
|
"ownerId": "string",
|
|
"text": "string",
|
|
"edited": "boolean",
|
|
"creationDate": "number"
|
|
}
|
|
]
|
|
}
|
|
```
|