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

Compare commits

base: gorb:6e4423e08babea500c42ad25e5b42f794d26e874
Branches Tags
gorb:main
gorb:backend
..
compare: gorb:ea0fbc6f5cba7fc8295961443a11e50e44ecc4e0
Branches Tags
gorb:main
gorb:backend

No commits in common. "6e4423e08babea500c42ad25e5b42f794d26e874" and "ea0fbc6f5cba7fc8295961443a11e50e44ecc4e0" have entirely different histories.
6e4423e08b ... ea0fbc6f5c

6 changed files with 71 additions and 71 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. 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
{ {
@ -26,9 +26,9 @@ 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 |

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

@ -10,10 +10,10 @@ Authenticates the user, and issues an access token for future requests.
| 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) |
| device_name | string | Name to help the user identify the device in their session list. | | device_name | string | Name to help the user identify the device in their session list |
```json ```json
{ {
@ -27,11 +27,11 @@ 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. |
--- ---
@ -39,16 +39,16 @@ Authenticates the user, and issues an access token for future requests.
| 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 |
| refresh_token | string | The refresh token that will be used to refresh the access token. Required for avoiding users having to log in after access token expiration. | | refresh_token | string | The refresh token that will be used to refresh the access token. Required for avoiding users having to log in after access token expiration. |
```json ```json
{ {
"access_token": "35e404d160b0eac766cb85cf513670baa627d1e918c4813c3f099e31de300b63", "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJAcmFkaWFsXzQ3NDA6Z29yYi5hcHAiLCJpZGVudGlmaWVyIjoicmFkaWFsXzQ3NDAiLCJpYXQiOjE3NDM4ODgyNDAsImV4cCI6MTc0NTk2MTg0MH0.MZsOfeOm98K2sgtJ3hIDy0iyX27tDJRgW5iSayBJIDM",
"user_id": "@radial_4740:gorb.app", "user_id": "@radial_4740:gorb.app",
"expires_in": 86400, "expires_in": 86400,
"refresh_token": "d9ce91b7b643d5580ea605ad09ba1e13aef704c412194c00c592b96a62049587" "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJAcmFkaWFsXzQ3NDA6Z29yYi5hcHAiLCJpZGVudGlmaWVyIjoicmFkaWFsXzQ3NDAiLCJpYXQiOjE3NDM4ODgyNDAsImV4cCI6MTc0NjQ4MDI0MH0.OvUDelrhELNBhizvAj7wm13YpDLYluI4sPeBmT5sPUg"
} }
``` ```

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

@ -10,10 +10,10 @@ Registers the user, and issues an access token for future requests.
| 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) |
| device_name | string | Name to help the user identify the device in their session list. | | device_name | string | Name to help the user identify the device in their session list |
```json ```json
{ {
@ -28,29 +28,29 @@ 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 |
--- ---
### 200 ### 200
| Name | Type | Description | | Name | Type | Description |
| ------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- | | ------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| access_token | string | **Required**: The JWT 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 |
| refresh_token | string | The JWT refresh token that will be used to refresh the access token. Required for avoiding users having to log in after access token expiration. | | refresh_token | string | The refresh token that will be used to refresh the access token. Required for avoiding users having to log in after access token expiration. |
```json ```json
{ {
"access_token": "13aa5fe2ae5874fb9616e68c25632a146552584ac238a3e4ede08174fbfc4f45", "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJAcmFkaWFsXzQ3NDA6Z29yYi5hcHAiLCJpZGVudGlmaWVyIjoicmFkaWFsXzQ3NDAiLCJpYXQiOjE3NDM4ODgyNDAsImV4cCI6MTc0NTk2MTg0MH0.MZsOfeOm98K2sgtJ3hIDy0iyX27tDJRgW5iSayBJIDM",
"user_id": "@radial_4740:gorb.app", "user_id": "@radial_4740:gorb.app",
"expires_in": 86400, "expires_in": 86400,
"refresh_token": "8556a85b8912a78572cd67b21350e188039f656a0781dab20fab7b72a11d2a93" "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJAcmFkaWFsXzQ3NDA6Z29yYi5hcHAiLCJpZGVudGlmaWVyIjoicmFkaWFsXzQ3NDAiLCJpYXQiOjE3NDM4ODgyNDAsImV4cCI6MTc0NjQ4MDI0MH0.OvUDelrhELNBhizvAj7wm13YpDLYluI4sPeBmT5sPUg"
} }
``` ```

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
{ {

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

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