gorb/specifications
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: fix more links

Browse source
This commit is contained in:
SauceyRed 2025-05-02 02:04:14 +02:00
parent ea12d693ed
commit d45796629b
Signed by: sauceyred
GPG key ID: 4BEDD9C389F924D0
4 changed files with 33 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

8
API/client-server/v1/servers/[serverId]/channels/[channelId]/messages.md
View file

@ -1,5 +1,5 @@
#### <b><span style="color: lightgreen;">GET</span> <code>/v1/servers/{serverId}/channels/{channelId}/messages</code></b>
Retrieves all [messages](../../../../../../models/Message.md) in a [Guild](../../../../../../models/Guild.md).
Retrieves all [messages](../../../../../../models/Message.md#message-object) in a [Guild](../../../../../../models/Guild.md#guild-object).
##### Responses
| Status | Description |
@ -11,9 +11,9 @@ Retrieves all [messages](../../../../../../models/Message.md) in a [Guild](../..
| 500 | An unhandled error occurred. |
###### 200
Returns a [[Message]] object.
Returns a [Message](../../../../../../models/Message.md#message-object) object.
#### <b><span style="color: lightgreen;">GET</span> <code>/v1/servers/{serverId}/channels/{channelId}/messages/{messageId}</code></b>
Retrieves a [[Message]] from a channel.
Retrieves a [Message](../../../../../../models/Message.md#message-object) from a [Channel]((../../../../../../models/Channel.md#channel-object)).
##### Responses
| Status | Description |
@ -25,4 +25,4 @@ Retrieves a [[Message]] from a channel.
| 500 | An unhandled error occurred. |
###### 200
Returns a [[Message]] object.
Returns a [Message](../../../../../../models/Message.md#message-object) object.

2
API/models/Guild.md
View file

@ -10,7 +10,7 @@ Represents a guild in an [Instance](Instance.md).
| name | string | Name of the guild |
| icon | string | URL for the icon |
| owner_id | string | ID of the owner |
| roles | array of [[#Role Object\|Role]] objects | Roles in the guild |
| roles | array of [Role](Role.md#role-object) objects | Roles in the guild |
| emojis | array of [Emoji](Emoji.md#emoji-object) objects | Emojis in the guild |
| member_count | integer | Number of members in the guild |

18
API/models/Message.md
View file

@ -1,18 +1,18 @@
## Message Object
Represents a message in a [Channel](Channel.md)/DM.
Represents a message in a [Channel](Channel.md#channel-object)/DM.
**Structure**
| Field | Type | Description |
| ----------- | -------------------------------------------------------------- | ----------------------------------------------- |
| ----------- | ------------------------------------------------- | ----------------------------------------------- |
| id | string | ID of the message |
| channel_id | string | ID of the channel the message was sent it |
| author | [User](User.md#user-object) object | Author of the message |
| content | string | Content of the message |
| created_at | timestamp | When the message was sent |
| edited | timestamp \| null | When this message was edited, null if it hasn't |
| attachments | array of [Attachment](Attachment.md#attachment-object) objects | Files attached with the message, empty if none |
| embeds | array of [Embed](Embed.md#embed-object) objects | Embeds sent with the message, empty if none |
| attachments | array of [Attachment](#attachment-object) objects | Files attached with the message, empty if none |
| embeds | array of [Embed](#embed-object) objects | Embeds sent with the message, empty if none |
**Example Message**
```json
{
@ -33,15 +33,15 @@ Represents a message in a [Channel](Channel.md)/DM.
```
## Embed Object
Represents an embed in a [[#Message Object|Message]].
Represents an embed in a [Message](Message.md#message-object).
**Structure**
| Field | Type | Description |
| ------ | ----------------------------------------- | ------------------- |
| ------ | --------------------------------------- | ------------------- |
| title | string | Title of the embed |
| color | integer | Color of the embed |
| fields | array of [[#Field Object\|Field]] objects | Fields of the embed |
| fields | array of [Field](#field-object) objects | Fields of the embed |
**Example Embed**
```json
@ -56,7 +56,7 @@ Represents an embed in a [[#Message Object|Message]].
}
```
### Field Object
Represents a field in an [[#Embed Object|Embed]].
Represents a field in an [Embed](#embed-object).
**Structure**
| Field | Type | Description |
@ -72,7 +72,7 @@ Represents a field in an [[#Embed Object|Embed]].
}
```
## Attachment Object
Represents an attachment in a [[#Message Object|Message]].
Represents an attachment in a [Message](#message-object).
**Structure**

9
API/models/Role.md Normal file
View file

@ -0,0 +1,9 @@
## Emoji Object
Represents an emoji in a [Guild](Guild.md#guild-object).
**Structure**
| Field | Type | Description |
| ----- | ------ | ----------------- |
| id | string | ID of the emoji |
| name | string | Name of the emoji |