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

feat: client-server/support implemented

Browse source
This commit is contained in:
JustTemmie 2025-04-28 22:23:04 +02:00
parent 6d1e63be6a
commit 53cd6287cc
1 changed files with 47 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

47
API/client-server/v1/support.md Normal file
View file

@ -0,0 +1,47 @@
GET /v1/support
---
## Request
No request parameters or request body.
---
## Responses
|Status|Description|
|-|-|
|200|Support information for the server|
|404|No contact information has been made available|
### 200 response
|Name|Type|Description|
|-|-|-|
|contacts|list[Contact]|A list of server administators|
|support_page|string|The URL of a webpage that may help users|
#### Contact
|Name|Type|Description|
|-|-|-|
|email_address|string|Email address for the administrator|
|gorb_id|string|The gorb ID for the administrator|
|role|string|**Required**: A simple description of this responsible for|
```json
{
"contacts": [
{
"email_address": "admin@gorbatron.org",
"role": "Main Administrator"
},
{
"email_address": "moderator@gorbatron.org",
"gorb_id": "@moderator.gorbatron.org",
"role": "Content Moderator"
}
],
"support_page": "https://help.gorb.app"
}
```