From ea12d693edbd9dd6e5f3d1aaaca7294451381b65 Mon Sep 17 00:00:00 2001 From: SauceyRed Date: Fri, 2 May 2025 01:57:02 +0200 Subject: [PATCH] docs: fix links --- .../channels/[channelId]/messages.md | 2 +- API/models/Emoji.md | 2 +- API/models/Guild.md | 22 +++++++++---------- API/models/Instance.md | 20 ++++++++--------- API/models/Message.md | 22 +++++++++---------- API/models/User.md | 3 ++- 6 files changed, 36 insertions(+), 35 deletions(-) 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 80123d1..5d7c85d 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 [[Message|messages]] in a [[Guild]]. +Retrieves all [messages](../../../../../../models/Message.md) in a [Guild](../../../../../../models/Guild.md). ##### Responses | Status | Description | diff --git a/API/models/Emoji.md b/API/models/Emoji.md index 542fd42..3214f47 100644 --- a/API/models/Emoji.md +++ b/API/models/Emoji.md @@ -1,5 +1,5 @@ ## Emoji Object -Represents an emoji in a [[Guild]]. +Represents an emoji in a [Guild](Guild.md). **Structure** diff --git a/API/models/Guild.md b/API/models/Guild.md index 7c6df95..c0abaed 100644 --- a/API/models/Guild.md +++ b/API/models/Guild.md @@ -1,18 +1,18 @@ ## Guild Object -Represents a guild in an [[Instance]]. +Represents a guild in an [Instance](Instance.md). **Structure** -| Field | Type | Description | -| ------------ | ---------------------------------------------- | ------------------------------ | -| id | string | ID of the guild | -| description | string | Description of the guild | -| 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 | -| emojis | array of [[Emoji#Emoji Object\|Emoji]] objects | Emojis in the guild | -| member_count | integer | Number of members in the guild | +| Field | Type | Description | +| ------------ | ----------------------------------------------- | ------------------------------ | +| id | string | ID of the guild | +| description | string | Description of the guild | +| 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 | +| emojis | array of [Emoji](Emoji.md#emoji-object) objects | Emojis in the guild | +| member_count | integer | Number of members in the guild | ### Role Object **Structure** diff --git a/API/models/Instance.md b/API/models/Instance.md index 3af1e5b..9fd4132 100644 --- a/API/models/Instance.md +++ b/API/models/Instance.md @@ -1,15 +1,15 @@ # We will probably have/need this right? -## Message Object +## Instance Object Represents a Gorb instance. **Structure** -| Field | Type | Description | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| id | string | ID of the instance | -| name | string | Name of the instance | -| accounts | integer | Number of accounts registered on the instance | -| uptime | integer | Seconds since the instance was last started | -| version | string | The version of Gorb that the instance is running | -| build_number | string | The build number of Gorb that the instance is running | -| guilds | array of [[Guild#Guild Object\|Guild]] objects | Guilds in the instance | +| Field | Type | Description | +| ------------ | ----------------------------------------------- | ----------------------------------------------------- | +| id | string | ID of the instance | +| name | string | Name of the instance | +| accounts | integer | Number of accounts registered on the instance | +| uptime | integer | Seconds since the instance was last started | +| version | string | The version of Gorb that the instance is running | +| build_number | string | The build number of Gorb that the instance is running | +| guilds | array of [Guild](Guild.md#guild-object) objects | Guilds in the instance | diff --git a/API/models/Message.md b/API/models/Message.md index 6948c91..a2955ef 100644 --- a/API/models/Message.md +++ b/API/models/Message.md @@ -1,18 +1,18 @@ ## Message Object -Represents a message in a [[Channel]]/DM. +Represents a message in a [Channel](Channel.md)/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]] 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 Object\|Attachment]] objects | Files attached with the message, empty if none | -| embeds | array of [[#Embed Object\|Embed]] 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.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 | **Example Message** ```json { diff --git a/API/models/User.md b/API/models/User.md index 5ba40ef..3ca80f1 100644 --- a/API/models/User.md +++ b/API/models/User.md @@ -1,4 +1,5 @@ -Represents a user of an [[Instance]]. +## User Object +Represents a user of an [Instance](Instance.md#instance-object). **Structure**