wizard docs

2026-03-26 18:31:52 +00:00 · 2021-09-09 17:30:20 +03:00
parent 21c065372b
commit 2fff57412f
1 changed files with 53 additions and 0 deletions
--- a/setup-wizard/docs.txt
+++ b/setup-wizard/docs.txt
@@ -0,0 +1,53 @@
+verifyProductKey
+    Request
+      key: string
+
+    response
+      "is-recovering" : boolean
+      "tor-address"   : string
+
+getEmbassyDrives
+    Request
+    
+    Response
+      {
+        logicalname: string
+        labels: string[]
+        capacity: number
+        used: number
+      }[]
+
+getRecoveryDrives
+    Request
+
+    Response
+      {
+        logicalname: string
+        version: string
+        name: string
+      }[]
+
+getDataTransferProgress
+    Request
+    
+    Response
+      'bytes-transfered' : number
+      'total-bytes'      : number
+
+verifyRecoveryPassword
+    Request
+      logicalname : string
+      password    : string
+    
+    Response
+      boolean
+
+setupEmbassy
+    Request
+      embassyLogicalname   : string,
+      embassyPassword      : string
+      recoveryLogicalname? : string,
+      recoveryPassword?    : string
+
+    Response
+      "tor-address": string