diff options
| author | curly <curlybryce@protonmail.com> | 2023-02-21 15:04:45 -0700 |
|---|---|---|
| committer | curly <curlybryce@protonmail.com> | 2023-02-21 15:04:45 -0700 |
| commit | a3b54a4b23866ae08c7f906d93f512c19db78d9d (patch) | |
| tree | 6a3ad28d88ecf8cd1af31a6eeb395201a0d789df /README.md | |
| parent | c47bd9c8e48de50610bfb107252d8f55af211ce6 (diff) | |
| download | rocket_test-a3b54a4b23866ae08c7f906d93f512c19db78d9d.tar.gz rocket_test-a3b54a4b23866ae08c7f906d93f512c19db78d9d.tar.bz2 rocket_test-a3b54a4b23866ae08c7f906d93f512c19db78d9d.zip | |
Database limits, User fields/status
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 54 |
1 files changed, 49 insertions, 5 deletions
@@ -25,6 +25,13 @@ DELETE `/delete_user` - Return type: JSON - Returns: `Result` +POST `set_user_data` + Sets data in the user fields +- Data type: JSON +- Data: `{user: UID, field: ReceiveDataField, data: String}` +- Return type: JSON +- Returns: `Result` + GET `/get_user/<id>` Gets a user from id - Return type: JSON @@ -60,10 +67,7 @@ GET `/get_message_list/<from_id>/<to_id>` POST `/send_message` Sends a message - Data type: JSON -- Data: - - `"sender": u64` - - `"message": String` - - `"reply_to": Option<u64>` +- Data: ReceiveMessage - Return type: JSON - Returns: `UID` of message @@ -72,4 +76,44 @@ DELETE `/delete_message` - Data type: JSON - Data: `UID` - Return type: JSON -- Returns: `Result`
\ No newline at end of file +- Returns: `Result` + +# Types +- ReceiveDataField + - DisplayName + - StatusText + - Desc + +- ReceiveMessage + - message: String + - sender: UID + - reply_to: Option<UID> + +- UID + - u64 + +- Date + - u64 (date since epoch in UTC) + +- Status + - Online + - Offline + - Away + - Busy + +- User + - id: UID + - username: String (Max 20 chars) + - displayname: String (Max 30 chars) + - desc: String (Max 500 chars) + - statustext: String (Max 60 chars) + - status: Status + - deleted: bool + +- Message + - id: UID + - message: String (Max 6000 chars) + - reply_to: UID (of another message) + - deleted: bool + - date: Date + - sender: UID (of a User)
\ No newline at end of file |