From 40b38517f8318b9dab7182842780331db539c0fb Mon Sep 17 00:00:00 2001 From: Horhik Date: Fri, 16 Apr 2021 18:44:07 +0300 Subject: [PATCH] update API page --- src/API.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) diff --git a/src/API.md b/src/API.md index 74c44de..03eb174 100644 --- a/src/API.md +++ b/src/API.md @@ -26,3 +26,77 @@ On base of password will be generted keypair for signing and keypair for encodin ## Adding friends Each user have :w +---- + +# Requests +``` Rust +pub enum Request { + StartApp, + StopApp, + LoadUsers, + #[serde(rename_all = "camelCase")] + SendMessage { + user_id: Id, + message: String, + }, + #[serde(rename_all = "camelCase")] + LoadMessages { + user_id: Id, + count: u32, + start_index: u32, + }, + #[serde(rename_all = "camelCase")] + AddUser { + name: String, + sign_key: String, + insert_key: String, + }, // CreateInstance TODO v0.3 +} +``` +## `StartApp` +Require when when client started. +``` json + { + type: "startApp" + } +``` + +## `StopApp` +``` json + { + type: "stopApp" + } +``` +## `LoadUsers` +``` json + { + type: "loadUsers" + } +``` +## `SendMessage` +``` json + { + type: "sendMessage", + userId: "UUID_V4...", + message: "hellow world" + } +``` +## `AddUser` +``` json + { + type: "addUser", + name: "username", + signKey: "USK@key...", + insertKey: "insertkey..." + } +``` +## `LoadMessages` +Requesting `count` messages from `userId` started from `startIndex`'s message +``` json + { + type: "loadMessages", + userId: "UUID_V4...", + count: 10, + startIndex: 30 + } +```