Compare commits

...

3 commits

2 changed files with 36 additions and 2 deletions

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|

View file

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