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

chore: add status 500 errors to every endpoint

Browse source
This commit is contained in:
JustTemmie 2025-04-29 21:53:17 +02:00
parent 0f993c39ec
commit 218f91dce2
6 changed files with 14 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -33,4 +33,5 @@ Sends a friend request to the given user. Friend requests can be accepted by hav
| 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. |
| 403 | Invalid access token. |
| 500 | An unhandled error occured. |

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

@ -32,6 +32,7 @@ Authenticates the user, and issues an access token for future requests.
| 200 | Authentication successful. |
| 400 | The post request included poorly formated data. |
| 403 | Part of the cridentials are invalid. |
| 500 | An unhandled error occured. |
---

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

@ -33,6 +33,7 @@ Registers the user, and issues an access token for future requests.
| 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. |
| 500 | An unhandled error occured. |
---

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

@ -11,13 +11,14 @@ No request parameters or request body.
## Responses
| Status | Description |
| ------ | -------------------------------- |
|--------|----------------------------------|
| 200 | The current stats of the server. |
| 500 | An unhandled error occured. |
### 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. |

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

@ -14,6 +14,7 @@ No request parameters or request body.
|--------|-------------------------------------------------|
| 200 | Support information for the server. |
| 404 | No contact information has been made available. |
| 500 | An unhandled error occured. |
### 200 response

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

@ -11,15 +11,16 @@ No request parameters or request body.
## Responses
| Status | Description |
| ------ | ------------------------------------- |
|--------|---------------------------------------|
| 200 | The versions supported by the server. |
| 500 | An unhandled error occured. |
### 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
{