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

docs: fix links

Browse source
This commit is contained in:
SauceyRed 2025-05-02 01:57:02 +02:00
parent 2ebb2594d7
commit ea12d693ed
Signed by: sauceyred
GPG key ID: 4BEDD9C389F924D0
6 changed files with 36 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

2
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 [[Message|messages]] in a [[Guild]].
Retrieves all [messages](../../../../../../models/Message.md) in a [Guild](../../../../../../models/Guild.md).
##### Responses
| Status | Description |

2
API/models/Emoji.md
View file

@ -1,5 +1,5 @@
## Emoji Object
Represents an emoji in a [[Guild]].
Represents an emoji in a [Guild](Guild.md).
**Structure**

22
API/models/Guild.md
View file

@ -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**

20
API/models/Instance.md
View file

@ -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 |

22
API/models/Message.md
View file

@ -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
{

3
API/models/User.md
View file

@ -1,4 +1,5 @@
Represents a user of an [[Instance]].
## User Object
Represents a user of an [Instance](Instance.md#instance-object).
**Structure**