diff --git a/README.md b/README.md index e5643f3..9682579 100644 --- a/README.md +++ b/README.md @@ -3,25 +3,32 @@ 1. AUTHENTICATION: authentication message and informations about messages to transfer 2. RESPONSE: OK or ERROR 3. loop: - # TRANSFER: message id, file chunk - # REPONSE: Ok + - TRANSFER: message id, file chunk + - REPONSE: Ok # messages content format: IPC USER MESSAGE TYPE, JSON ENCODED MESSAGE 1. AUTHENTICATION message + 1, { message-id: "UUID", token: "JWT", files: [ { name: "NAME", size: SIZE-IN-BYTES (unsigned int 64 bits) }, { name: "NAME", size: SIZE-IN-BYTES (unsigned int 64 bits) }, ], fid: "UUID", tags: [ TAG-NAME, TAG-NAME ] } + note: The server knows the user id from the token (JWT) and stores the received files in a 2. RESPONSE message + 2, { message-id: "UUID", response: "Ok" } + or + 2, { message-id: "UUID", response: "Error", reason: "REASON" } + 3. TRANSFER message + 3, { message-id: "UUID", chunk: "UUID", data: [ BINARY DATA ] } # Rationale