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

Compare commits

base: gorb:289110128608e9e17f297d7f8a16e6f73c516d84
Branches Tags
gorb:main
gorb:backend
..
compare: gorb:bb7291520198160635f3473271d7fc307d023990
Branches Tags
gorb:main
gorb:backend

3 commits
2891101286 ... bb72915201

Author SHA1 Message Date
JustTemmie
bb72915201 Merge remote-tracking branch 'refs/remotes/origin/main' 2025-04-28 23:35:16 +02:00
JustTemmie
2f8a653148 feat: implement client-server/friend-request 2025-04-28 23:33:21 +02:00
JustTemmie
cbb563c4d6 fix: change error code from 401 to 403 2025-04-28 23:33:06 +02:00
2 changed files with 36 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -0,0 +1,34 @@
POST /v1/friend-request
---
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|
```json
{
"access_token": "gwLhWXD9wrqL3DwxXZ0VHUeOjr8am1yO",
"identifier": "@radial_4740:gorb.app",
"message": "Heyo, Kira here"
}
```
---
## 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|

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

@ -32,7 +32,7 @@ Registers the user, and issues an access token for future requests.
| ------ | ----------------------------------------------------------------------------------------------------------------------------- |
| 200 | Registration successful |
| 400 | The post request included poorly formated data |
| 401 | 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 |
---
@ -55,7 +55,7 @@ Registers the user, and issues an access token for future requests.
---
### 401
### 403
| Name | Type | Description |
| --------------------------- | ---- | ------------------------------------------------------------------------------ |