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

fix: prettify markdown tables

Browse source
This commit is contained in:
JustTemmie 2025-04-28 23:37:12 +02:00
parent bb72915201
commit 42fca503d8
6 changed files with 46 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -8,11 +8,11 @@ Sends a friend request to the given user.
## 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
{ {
@ -26,9 +26,9 @@ Sends a friend request to the given user.
## 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 |

6
API/client-server/v1/login.md
View file

@ -9,7 +9,7 @@ Authenticates the user, and issues an access token for future requests.
## Request ## Request
| Name | Type | Description | | Name | Type | Description |
| ----------- | ------ | -------------------------------------------------------------------------------------------------------------- | |-------------|--------|----------------------------------------------------------------------------------------------------------------|
| identifier | string | User's gorb ID. One of identifier and email **must** be implemented | | identifier | string | User's gorb ID. One of identifier and email **must** be implemented |
| email | string | User's email. One of identifier and email **must** be implemented | | email | string | User's email. One of identifier and email **must** be implemented |
| password | string | **Required**: The user's password (we need to figure out how exactly we're hashing + salting it on the client) | | password | string | **Required**: The user's password (we need to figure out how exactly we're hashing + salting it on the client) |
@ -28,7 +28,7 @@ Authenticates the user, and issues an access token for future requests.
## Responses ## Responses
| Status | Description | | Status | Description |
| ------ | ---------------------------------------------- | |--------|------------------------------------------------|
| 200 | Authentication successful | | 200 | Authentication successful |
| 400 | The post request included poorly formated data | | 400 | The post request included poorly formated data |
| 403 | Part of the cridentials are invalid. | | 403 | Part of the cridentials are invalid. |
@ -38,7 +38,7 @@ Authenticates the user, and issues an access token for future requests.
### 200 ### 200
| Name | Type | Description | | Name | Type | Description |
| ------------ | ------ | --------------------------------------------------------------------------- | |--------------|--------|-----------------------------------------------------------------------------|
| access_token | string | **Required**: The access token that will be used for further authentication | | access_token | string | **Required**: The access token that will be used for further authentication |
| user_id | string | **Required**: The full gorb ID for the account | | user_id | string | **Required**: The full gorb ID for the account |
| expires_in | int | How many seconds until the token expires and is invalidated | | expires_in | int | How many seconds until the token expires and is invalidated |

8
API/client-server/v1/register.md
View file

@ -9,7 +9,7 @@ Registers the user, and issues an access token for future requests.
## Request ## Request
| Name | Type | Description | | Name | Type | Description |
| ----------- | ------ | -------------------------------------------------------------------------------------------------------------- | |-------------|--------|----------------------------------------------------------------------------------------------------------------|
| identifier | string | **Required** User's desired ID | | identifier | string | **Required** User's desired ID |
| email | string | **Required** User's email | | email | string | **Required** User's email |
| password | string | **Required**: The user's password (we need to figure out how exactly we're hashing + salting it on the client) | | password | string | **Required**: The user's password (we need to figure out how exactly we're hashing + salting it on the client) |
@ -29,7 +29,7 @@ Registers the user, and issues an access token for future requests.
## Responses ## Responses
| Status | Description | | Status | Description |
| ------ | ----------------------------------------------------------------------------------------------------------------------------- | |--------|-------------------------------------------------------------------------------------------------------------------------------|
| 200 | Registration successful | | 200 | Registration successful |
| 400 | The post request included poorly formated data | | 400 | The post request included poorly formated data |
| 403 | Signups are disabled, gorb ID not available, email already in use, or password doesn't meet the minimum security requirements | | 403 | Signups are disabled, gorb ID not available, email already in use, or password doesn't meet the minimum security requirements |
@ -39,7 +39,7 @@ Registers the user, and issues an access token for future requests.
### 200 ### 200
| Name | Type | Description | | Name | Type | Description |
| ------------ | ------ | --------------------------------------------------------------------------- | |--------------|--------|-----------------------------------------------------------------------------|
| access_token | string | **Required**: The access token that will be used for further authentication | | access_token | string | **Required**: The access token that will be used for further authentication |
| user_id | string | **Required**: The full gorb ID for the account | | user_id | string | **Required**: The full gorb ID for the account |
| expires_in | int | How many seconds until the token expires and is invalidated | | expires_in | int | How many seconds until the token expires and is invalidated |
@ -58,7 +58,7 @@ Registers the user, and issues an access token for future requests.
### 403 ### 403
| Name | Type | Description | | Name | Type | Description |
| --------------------------- | ---- | ------------------------------------------------------------------------------ | |-----------------------------|------|--------------------------------------------------------------------------------|
| signups_enabled | bool | Does the server have signups enabled? | | signups_enabled | bool | Does the server have signups enabled? |
| gorb_id_valid | bool | Is the given gorb ID even valid? | | gorb_id_valid | bool | Is the given gorb ID even valid? |
| gorb_id_available | bool | Is the given gorb ID available? | | gorb_id_available | bool | Is the given gorb ID available? |

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

@ -10,18 +10,18 @@ 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
{ {

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

@ -10,24 +10,24 @@ 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
{ {

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

@ -10,15 +10,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|string:bool|Unstable features that are supported by the server. Features not listed here indicate that a feature isn't supported.| | unstable_features | 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