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

15
API/models/Instance.md Normal file
View file

@ -0,0 +1,15 @@
# We will probably have/need this right?
## Message 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 |