summaryrefslogtreecommitdiff
path: root/libeufin/api-nexus.rst
diff options
context:
space:
mode:
authorMS <ms@taler.net>2020-10-27 16:21:28 +0100
committerMS <ms@taler.net>2020-10-27 16:21:28 +0100
commit00416a79f21f0d9b910dcf508a856a45562119d2 (patch)
tree8b60bba21a996e50ecf8a518178d6c5802a92751 /libeufin/api-nexus.rst
parent8f9558c8270f85d7b9f64542e71b8f26012a7996 (diff)
downloaddocs-00416a79f21f0d9b910dcf508a856a45562119d2.tar.gz
docs-00416a79f21f0d9b910dcf508a856a45562119d2.tar.bz2
docs-00416a79f21f0d9b910dcf508a856a45562119d2.zip
reword nexus API
Diffstat (limited to 'libeufin/api-nexus.rst')
-rw-r--r--libeufin/api-nexus.rst41
1 files changed, 29 insertions, 12 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index 1d35a4ff..6d8ecdbe 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -265,23 +265,41 @@ to the real bank.
**Request:**
+ This request can accept two formats, depending on whether a
+ new bank connection is being made, or a connection backup is
+ being restored.
+
+
+ This type allows the creation of new bank accounts.
+ .. ts:def:: NewBankConnection
+
+ interface NewBankConnection {
+
+ source: string; // only "new" allowed
+
+ // connection name.
+ name: string;
+
+ // type of the connection to make: "ebics" for example.
+ type: string;
+
+ data: BankConnectionNew;
+ }
+
+ This type allows to restore a previously made bank connection.
.. ts:def:: BankConnectionRestoreRequest
interface BankConnectionRestoreRequest {
- source: "new" | "backup";
-
+ source: "backup";
+
+ // connection name.
name: string;
- type: string; // "ebics" for example.
- // Restore a previous connection. Take precedence
- // over the 'new' field.
- backup?: BankConnectionBackup;
+
+ // Backup data, as typically returned by the "../export-backup" API.
+ backup: BankConnectionBackup;
passphrase?: string;
-
- // Data to create a fresh bank connection without
- // restoring any backup.
- data?: BankConnectionNew;
}
@@ -307,8 +325,7 @@ to the real bank.
interface BankConnectionBackup {
// The information needed in this type depend entirely
- // on which connectionis being restored.
-
+ // on which connection is being restored.
}
**Response:**