diff --git a/API/client-server/v1/servers/[serverId]/channels/[channelId]/messages.md b/API/client-server/v1/servers/[serverId]/channels/[channelId]/messages.md index 5d7c85d..3b660a9 100644 --- a/API/client-server/v1/servers/[serverId]/channels/[channelId]/messages.md +++ b/API/client-server/v1/servers/[serverId]/channels/[channelId]/messages.md @@ -1,5 +1,5 @@ #### GET /v1/servers/{serverId}/channels/{channelId}/messages -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. #### GET /v1/servers/{serverId}/channels/{channelId}/messages/{messageId} -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. \ No newline at end of file +Returns a [Message](../../../../../../models/Message.md#message-object) object. \ No newline at end of file diff --git a/API/models/Guild.md b/API/models/Guild.md index c0abaed..64893a9 100644 --- a/API/models/Guild.md +++ b/API/models/Guild.md @@ -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 | diff --git a/API/models/Message.md b/API/models/Message.md index a2955ef..2ee6425 100644 --- a/API/models/Message.md +++ b/API/models/Message.md @@ -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 | +| 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-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 | +| Field | Type | Description | +| ------ | --------------------------------------- | ------------------- | +| title | string | Title of the embed | +| color | integer | Color 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** diff --git a/API/models/Role.md b/API/models/Role.md new file mode 100644 index 0000000..b64458d --- /dev/null +++ b/API/models/Role.md @@ -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 |