diff --git a/API/client-server/v1/friend-request.md b/API/client-server/v1/friend-request.md index 7efb5ac..c791e40 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. Friend requests can be accepted by hav ## 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. Friend requests can be accepted by hav ## 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/stats.md b/API/client-server/v1/stats.md index 1976bc0..dbd9ad1 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 c185481..edc9848 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 0d8ea42..3f056c9 100644 --- a/API/client-server/versions.md +++ b/API/client-server/versions.md @@ -10,16 +10,16 @@ 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 | 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 +| 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. | +| versions | list[string] | **Required**: The supported protocol versions. | ```json {