✨ Fixed broken links for messages endpoint description
❗ Should probably have a section for messages under structures
This commit is contained in:
parent
231141221b
commit
ba7b33ae62
@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
title: Invites
|
title: Invites
|
||||||
anchor: invites-ep
|
anchor: invites-ep
|
||||||
weight: 15
|
weight: 16
|
||||||
---
|
---
|
||||||
|
|
||||||
### `POST /invite/create`
|
### `POST /invite/create`
|
||||||
|
@ -67,81 +67,5 @@ Example
|
|||||||
< { "members": [...] }
|
< { "members": [...] }
|
||||||
```
|
```
|
||||||
|
|
||||||
## Messages
|
|
||||||
|
|
||||||
### `POST /message/send`
|
|
||||||
|
|
||||||
* Required permissions:
|
|
||||||
* SEND_MESSAGES
|
|
||||||
|
|
||||||
* Required query string parameters:
|
|
||||||
* id: u64
|
|
||||||
* jwt: String
|
|
||||||
|
|
||||||
* channel_id: u64
|
|
||||||
* type: String
|
|
||||||
|
|
||||||
Valid values:
|
|
||||||
|
|
||||||
* text
|
|
||||||
* jpeg
|
|
||||||
* png
|
|
||||||
* webm
|
|
||||||
* mp4
|
|
||||||
|
|
||||||
* Required body:
|
|
||||||
* Content itself should always go in the body
|
|
||||||
* Empty bodies result in an HTTP 400 response
|
|
||||||
|
|
||||||
* Returns:
|
|
||||||
* None
|
|
||||||
|
|
||||||
### `GET /message/get_range`
|
|
||||||
|
|
||||||
* Required query string parameters:
|
|
||||||
* id: u64
|
|
||||||
* jwt: string
|
|
||||||
|
|
||||||
* channel_id: u64
|
|
||||||
* start_time: i64
|
|
||||||
* Unix timestamp (seconds)
|
|
||||||
* end_time: i64
|
|
||||||
* Unix timestamp (seconds)
|
|
||||||
|
|
||||||
* limit: Optional<u64>
|
|
||||||
* Maximum = 1000
|
|
||||||
|
|
||||||
* Returns
|
|
||||||
* messages: Array<Message>
|
|
||||||
|
|
||||||
|
|
||||||
Example
|
|
||||||
```
|
|
||||||
> GET /message/get_range?id=123&jwt=...
|
|
||||||
|
|
||||||
< { "mesages": [...] }
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### `GET /message/from_id`
|
|
||||||
|
|
||||||
* Required query string parameters:
|
|
||||||
* id: u64
|
|
||||||
* jwt: string
|
|
||||||
|
|
||||||
* channel_id: u64
|
|
||||||
* start: u64
|
|
||||||
* limit: Optional<u64>
|
|
||||||
* Maximum = 1000
|
|
||||||
|
|
||||||
* Returns
|
|
||||||
* messages: Array<Message>
|
|
||||||
|
|
||||||
Example
|
|
||||||
```
|
|
||||||
> GET /message/from_id?id=123&jwt=...
|
|
||||||
|
|
||||||
< { "mesages": [...] }
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
83
docs/content/endpoints/mesages.md
Normal file
83
docs/content/endpoints/mesages.md
Normal file
@ -0,0 +1,83 @@
|
|||||||
|
---
|
||||||
|
title: Messages
|
||||||
|
anchor: messages-ep
|
||||||
|
weight: 15
|
||||||
|
---
|
||||||
|
|
||||||
|
## Messages
|
||||||
|
|
||||||
|
### `POST /message/send`
|
||||||
|
|
||||||
|
* Required permissions:
|
||||||
|
* SEND_MESSAGES
|
||||||
|
|
||||||
|
* Required query string parameters:
|
||||||
|
* id: u64
|
||||||
|
* jwt: String
|
||||||
|
|
||||||
|
* channel_id: u64
|
||||||
|
* type: String
|
||||||
|
|
||||||
|
Valid values:
|
||||||
|
|
||||||
|
* text
|
||||||
|
* jpeg
|
||||||
|
* png
|
||||||
|
* webm
|
||||||
|
* mp4
|
||||||
|
|
||||||
|
* Required body:
|
||||||
|
* Content itself should always go in the body
|
||||||
|
* Empty bodies result in an HTTP 400 response
|
||||||
|
|
||||||
|
* Returns:
|
||||||
|
* None
|
||||||
|
|
||||||
|
### `GET /message/get_range`
|
||||||
|
|
||||||
|
* Required query string parameters:
|
||||||
|
* id: u64
|
||||||
|
* jwt: string
|
||||||
|
|
||||||
|
* channel_id: u64
|
||||||
|
* start_time: i64
|
||||||
|
* Unix timestamp (seconds)
|
||||||
|
* end_time: i64
|
||||||
|
* Unix timestamp (seconds)
|
||||||
|
|
||||||
|
* limit: Optional<u64>
|
||||||
|
* Maximum = 1000
|
||||||
|
|
||||||
|
* Returns
|
||||||
|
* messages: Array<Message>
|
||||||
|
|
||||||
|
|
||||||
|
Example
|
||||||
|
```
|
||||||
|
> GET /message/get_range?id=123&jwt=...
|
||||||
|
|
||||||
|
< { "mesages": [...] }
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### `GET /message/from_id`
|
||||||
|
|
||||||
|
* Required query string parameters:
|
||||||
|
* id: u64
|
||||||
|
* jwt: string
|
||||||
|
|
||||||
|
* channel_id: u64
|
||||||
|
* start: u64
|
||||||
|
* limit: Optional<u64>
|
||||||
|
* Maximum = 1000
|
||||||
|
|
||||||
|
* Returns
|
||||||
|
* messages: Array<Message>
|
||||||
|
|
||||||
|
Example
|
||||||
|
```
|
||||||
|
> GET /message/from_id?id=123&jwt=...
|
||||||
|
|
||||||
|
< { "mesages": [...] }
|
||||||
|
```
|
||||||
|
|
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Messages
|
title: Messages
|
||||||
anchor: messages
|
anchor: messages-struct
|
||||||
weight: 40
|
weight: 40
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user