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

chore: fixed table formatting and added periods

Browse source
This commit is contained in:
SauceyRed 2025-04-29 18:01:15 +02:00
parent ea0fbc6f5c
commit 0211348abc
Signed by: sauceyred
GPG key ID: 4BEDD9C389F924D0
4 changed files with 40 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

18
API/client-server/v1/friend-request.md
View file

@ -9,10 +9,10 @@ Sends a friend request to the given user. Friend requests can be accepted by hav
## Request ## Request
| Name | Type | Description | | Name | Type | Description |
|--------------|--------|-----------------------------------------------------------------------------------------------| | ------------ | ------ | ---------------------------------------------------------------------------------------------- |
| access_token | string | **Required**: The user's auth token | | access_token | string | **Required**: The user's auth token. |
| identifier | string | **Required**: The gorb ID of the user they want to friend | | identifier | string | **Required**: The gorb ID of the user they want to friend. |
| message | string | A message to send along with the friend request, for example to find to tell them who you are | | message | string | A message to send along with the friend request, for example to find to tell them who you are. |
```json ```json
{ {
@ -27,8 +27,8 @@ Sends a friend request to the given user. Friend requests can be accepted by hav
## Responses ## Responses
| Status | Description | | Status | Description |
|--------|------------------------------------------------------------------------------| | ------ | ----------------------------------------------------------------------------- |
| 200 | Friend request sucessfully sent | | 200 | Friend request sucessfully sent. |
| 400 | The post request included poorly formated data | | 400 | The post request included poorly formated data. |
| 401 | The recipient is not accepting friend requests from the sender at the moment | | 401 | The recipient is not accepting friend requests from the sender at the moment. |
| 403 | Invalid access token | | 403 | Invalid access token. |

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

@ -11,17 +11,17 @@ No request parameters or request body.
## Responses ## Responses
| Status | Description | | Status | Description |
|--------|---------------------------------| | ------ | -------------------------------- |
| 200 | The current stats of the server | | 200 | The current stats of the server. |
### 200 response ### 200 response
| Name | Type | Description | | Name | Type | Description |
|--------------|--------|--------------------------------------------------------------------------------------------| | ------------ | ------ | ------------------------------------------------------------------------------------------- |
| accounts | int | The number of signed up accounts | | accounts | int | The number of signed up accounts. |
| uptime | int | How many seconds the server has been running | | uptime | int | How many seconds the server has been running. |
| version | string | The current server version | | version | string | The current server version. |
| build_number | string | The hash of the last commit in the git repo? (maybe we want to define this some other way) | | build_number | string | The hash of the last commit in the git repo? (maybe we want to define this some other way). |
```json ```json
{ {

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

@ -11,23 +11,23 @@ No request parameters or request body.
## Responses ## Responses
| Status | Description | | Status | Description |
|--------|------------------------------------------------| | ------ | ----------------------------------------------- |
| 200 | Support information for the server | | 200 | Support information for the server. |
| 404 | No contact information has been made available | | 404 | No contact information has been made available. |
### 200 response ### 200 response
| Name | Type | Description | | Name | Type | Description |
|--------------|---------------|------------------------------------------| | ------------ | ------------- | ----------------------------------------- |
| contacts | list[Contact] | A list of server administators | | contacts | list[Contact] | A list of server administators. |
| support_page | string | The URL of a webpage that may help users | | support_page | string | The URL of a webpage that may help users. |
#### Contact #### Contact
| Name | Type | Description | | Name | Type | Description |
|---------------|--------|------------------------------------------------------------| | ------------- | ------ | ----------------------------------------------------------- |
| email_address | string | Email address for the administrator | | email_address | string | Email address for the administrator. |
| gorb_id | string | The gorb ID for the administrator | | gorb_id | string | The gorb ID for the administrator. |
| role | string | **Required**: A simple description of this responsible for | | role | string | **Required**: A simple description of this responsible for. |
```json ```json
{ {

8
API/client-server/versions.md
View file

@ -11,15 +11,15 @@ No request parameters or request body.
## Responses ## Responses
| Status | Description | | Status | Description |
|--------|--------------------------------------| | ------ | ------------------------------------- |
| 200 | The versions supported by the server | | 200 | The versions supported by the server. |
### 200 response ### 200 response
| Name | Type | Description | | Name | Type | Description |
|-------------------|-------------------|-----------------------------------------------------------------------------------------------------------------------| | -------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------- |
| unstable_features | dict[string:bool] | Unstable features that are supported by the server. Features not listed here indicate that a feature isn't supported. | | unstable_features | dict[string:bool] | Unstable features that are supported by the server. Features not listed here indicate that a feature isn't supported. |
|versions|list[string]|**Required**: The supported protocol versions | versions | list[string] | **Required**: The supported protocol versions. |
```json ```json
{ {