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

Merge remote-tracking branch 'refs/remotes/origin/main'

Browse source
This commit is contained in:
JustTemmie 2025-04-28 23:35:16 +02:00
commit bb72915201
2 changed files with 70 additions and 68 deletions
Download patch file Download diff file Expand all files Collapse all files

11
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,15 +38,16 @@ 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 |
```json ```json
{ {
"access_token": "gwLhWXD9wrqL3DwxXZ0VHUeOjr8am1yO", "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJAcmFkaWFsXzQ3NDA6Z29yYi5hcHAiLCJpZGVudGlmaWVyIjoicmFkaWFsXzQ3NDAiLCJpYXQiOjE3NDM4ODgyNDAsImV4cCI6MTc0NTk2MTg0MH0.MZsOfeOm98K2sgtJ3hIDy0iyX27tDJRgW5iSayBJIDM",
"user_id": "@radial_4740:gorb.app", "user_id": "@radial_4740:gorb.app",
"expires_in": 2592000 "expires_in": 86400,
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJAcmFkaWFsXzQ3NDA6Z29yYi5hcHAiLCJpZGVudGlmaWVyIjoicmFkaWFsXzQ3NDAiLCJpYXQiOjE3NDM4ODgyNDAsImV4cCI6MTc0NjQ4MDI0MH0.OvUDelrhELNBhizvAj7wm13YpDLYluI4sPeBmT5sPUg"
} }
``` ```

15
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,16 +39,17 @@ 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 |
```json ```json
{ {
"access_token": "gwLhWXD9wrqL3DwxXZ0VHUeOjr8am1yO", "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJAcmFkaWFsXzQ3NDA6Z29yYi5hcHAiLCJpZGVudGlmaWVyIjoicmFkaWFsXzQ3NDAiLCJpYXQiOjE3NDM4ODgyNDAsImV4cCI6MTc0NTk2MTg0MH0.MZsOfeOm98K2sgtJ3hIDy0iyX27tDJRgW5iSayBJIDM",
"user_id": "@radial_4740:gorb.app", "user_id": "@radial_4740:gorb.app",
"expires_in": 2592000 "expires_in": 86400,
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJAcmFkaWFsXzQ3NDA6Z29yYi5hcHAiLCJpZGVudGlmaWVyIjoicmFkaWFsXzQ3NDAiLCJpYXQiOjE3NDM4ODgyNDAsImV4cCI6MTc0NjQ4MDI0MH0.OvUDelrhELNBhizvAj7wm13YpDLYluI4sPeBmT5sPUg"
} }
``` ```
@ -57,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? |
@ -78,6 +79,6 @@ Registers the user, and issues an access token for future requests.
"password_minimum_length": true, "password_minimum_length": true,
"password_special_characters": false, "password_special_characters": false,
"password_letters": true, "password_letters": true,
"password_numbers": true, "password_numbers": true
} }
``` ```