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

fix: ensure consitant naming of keys

Browse source
This commit is contained in:
JustTemmie 2025-04-29 21:39:17 +02:00
parent 25b75bee87
commit 0f993c39ec
4 changed files with 21 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

14
API/client-server/v1/support.md
View file

@ -11,34 +11,34 @@ 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. |
| user_id | string | The local user ID for the administrator in question. |
| role | string | **Required**: A simple description of this responsible for. |
```json
{
"contacts": [
{
"email_address": "admin@gorbatron.org",
"email_address": "admin@gorb.app",
"role": "Main Administrator"
},
{
"email_address": "moderator@gorbatron.org",
"gorb_id": "@moderator@gorbatron.org",
"email_address": "moderator@gorb.app",
"user_id": "moderator",
"role": "Content Moderator"
}
],