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

docs: added endpoints and object models

Browse source
This commit is contained in:
SauceyRed 2025-05-02 01:42:24 +02:00
parent ebab7e4fb3
commit 142cc5a448
Signed by: sauceyred
GPG key ID: 4BEDD9C389F924D0
7 changed files with 184 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

25
API/models/Guild.md Normal file
View file

@ -0,0 +1,25 @@
## Guild Object
Represents a guild in an [[Instance]].
**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 |
### Role Object
**Structure**
| Field | Type | Description |
| ----- | ------ | ----------------------- |
| id | string | ID of the role |
| name | string | Name of the role |
| icon | string | URL for the role's icon |