From 42fca503d8ee8107459ab060d4958ba8d912aea5 Mon Sep 17 00:00:00 2001 From: JustTemmie <47639983+JustTemmie@users.noreply.github.com> Date: Mon, 28 Apr 2025 23:37:12 +0200 Subject: [PATCH] fix: prettify markdown tables --- API/client-server/v1/friend-request.md | 22 +++++++++++----------- API/client-server/v1/login.md | 6 +++--- API/client-server/v1/register.md | 8 ++++---- API/client-server/v1/stats.md | 18 +++++++++--------- API/client-server/v1/support.md | 26 +++++++++++++------------- API/client-server/versions.md | 12 ++++++------ 6 files changed, 46 insertions(+), 46 deletions(-) diff --git a/API/client-server/v1/friend-request.md b/API/client-server/v1/friend-request.md index 25e2bc7..b1ad509 100644 --- a/API/client-server/v1/friend-request.md +++ b/API/client-server/v1/friend-request.md @@ -8,11 +8,11 @@ Sends a friend request to the given user. ## Request -|Name|Type|Description| -|-|-|-| -|access_token|string|**Required**: The user's auth token| -|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| +| Name | Type | Description | +|--------------|--------|-----------------------------------------------------------------------------------------------| +| access_token | string | **Required**: The user's auth token | +| 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 | ```json { @@ -26,9 +26,9 @@ Sends a friend request to the given user. ## Responses -|Status|Description| -|-|-| -|200|Friend request sucessfully sent| -|400|The post request included poorly formated data| -|401|The recipient is not accepting friend requests from the sender at the moment| -|403|Invalid access token| \ No newline at end of file +| Status | Description | +|--------|------------------------------------------------------------------------------| +| 200 | Friend request sucessfully sent | +| 400 | The post request included poorly formated data | +| 401 | The recipient is not accepting friend requests from the sender at the moment | +| 403 | Invalid access token | \ No newline at end of file diff --git a/API/client-server/v1/login.md b/API/client-server/v1/login.md index d21d566..b35f73b 100644 --- a/API/client-server/v1/login.md +++ b/API/client-server/v1/login.md @@ -9,7 +9,7 @@ Authenticates the user, and issues an access token for future requests. ## Request | Name | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------- | +|-------------|--------|----------------------------------------------------------------------------------------------------------------| | 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 | | 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 | Status | Description | -| ------ | ---------------------------------------------- | +|--------|------------------------------------------------| | 200 | Authentication successful | | 400 | The post request included poorly formated data | | 403 | Part of the cridentials are invalid. | @@ -38,7 +38,7 @@ Authenticates the user, and issues an access token for future requests. ### 200 | Name | Type | Description | -| ------------ | ------ | --------------------------------------------------------------------------- | +|--------------|--------|-----------------------------------------------------------------------------| | 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 | | expires_in | int | How many seconds until the token expires and is invalidated | diff --git a/API/client-server/v1/register.md b/API/client-server/v1/register.md index 884b3bc..4ddbe18 100644 --- a/API/client-server/v1/register.md +++ b/API/client-server/v1/register.md @@ -9,7 +9,7 @@ Registers the user, and issues an access token for future requests. ## Request | Name | Type | Description | -| ----------- | ------ | -------------------------------------------------------------------------------------------------------------- | +|-------------|--------|----------------------------------------------------------------------------------------------------------------| | identifier | string | **Required** User's desired ID | | 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) | @@ -29,7 +29,7 @@ Registers the user, and issues an access token for future requests. ## Responses | Status | Description | -| ------ | ----------------------------------------------------------------------------------------------------------------------------- | +|--------|-------------------------------------------------------------------------------------------------------------------------------| | 200 | Registration successful | | 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 | @@ -39,7 +39,7 @@ Registers the user, and issues an access token for future requests. ### 200 | Name | Type | Description | -| ------------ | ------ | --------------------------------------------------------------------------- | +|--------------|--------|-----------------------------------------------------------------------------| | 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 | | 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 | Name | Type | Description | -| --------------------------- | ---- | ------------------------------------------------------------------------------ | +|-----------------------------|------|--------------------------------------------------------------------------------| | signups_enabled | bool | Does the server have signups enabled? | | gorb_id_valid | bool | Is the given gorb ID even valid? | | gorb_id_available | bool | Is the given gorb ID available? | diff --git a/API/client-server/v1/stats.md b/API/client-server/v1/stats.md index ff9d81e..1976bc0 100644 --- a/API/client-server/v1/stats.md +++ b/API/client-server/v1/stats.md @@ -10,18 +10,18 @@ No request parameters or request body. ## Responses -|Status|Description| -|-|-| -|200|The current stats of the server| +| Status | Description | +|--------|---------------------------------| +| 200 | The current stats of the server | ### 200 response -|Name|Type|Description| -|-|-|-| -|accounts|int|The number of signed up accounts| -|uptime|int|How many seconds the server has been running| -|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)| +| Name | Type | Description | +|--------------|--------|--------------------------------------------------------------------------------------------| +| accounts | int | The number of signed up accounts | +| uptime | int | How many seconds the server has been running | +| 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) | ```json { diff --git a/API/client-server/v1/support.md b/API/client-server/v1/support.md index 3854a32..c185481 100644 --- a/API/client-server/v1/support.md +++ b/API/client-server/v1/support.md @@ -10,24 +10,24 @@ No request parameters or request body. ## Responses -|Status|Description| -|-|-| -|200|Support information for the server| -|404|No contact information has been made available| +| 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| +| 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| +| 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 { diff --git a/API/client-server/versions.md b/API/client-server/versions.md index 5a004af..7b24694 100644 --- a/API/client-server/versions.md +++ b/API/client-server/versions.md @@ -10,15 +10,15 @@ No request parameters or request body. ## Responses -|Status|Description| -|-|-| -|200|The versions supported by the server| +| Status | Description | +|--------|--------------------------------------| +| 200 | The versions supported by the server | ### 200 response -|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.| +| 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. | |versions|list[string]|**Required**: The supported protocol versions ```json