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

fix: ensure consitant naming of keys

Browse source
This commit is contained in:
JustTemmie 2025-04-29 21:39:17 +02:00
parent 25b75bee87
commit 0f993c39ec
4 changed files with 21 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -9,15 +9,17 @@ Sends a friend request to the given user. Friend requests can be accepted by hav
## 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. |
| uuid | string | **Required**: The UUID of the user they want to befriend. |
| server | string | The instance that user is on, can be left out if it's a local friend request. |
| 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",
"uuid": "dcb445f1-16e7-4cd9-ac19-af07acaeb865",
"server": "gorb.app",
"message": "Heyo, Kira here"
}
```
@ -27,7 +29,7 @@ Sends a friend request to the given user. Friend requests can be accepted by hav
## 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. |