[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] 01/02: pass over facade API
From: |
gnunet |
Subject: |
[taler-docs] 01/02: pass over facade API |
Date: |
Mon, 20 Mar 2023 09:23:44 +0100 |
This is an automated email from the git hooks/post-receive script.
ms pushed a commit to branch master
in repository docs.
commit e6a667d002a63d66dfe5980ab99144d629974f1c
Author: ms <ms@taler.net>
AuthorDate: Sun Mar 19 22:15:09 2023 +0100
pass over facade API
---
libeufin/api-nexus.rst | 39 ++++++++++++++++++++++++---------------
1 file changed, 24 insertions(+), 15 deletions(-)
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index 91a3b5e..998f6b3 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -835,8 +835,7 @@ Facades
.. http:get:: <nexus>/facades/{fcid}
- **Response:** A `FacadeShowInfo` pointed to by ``fcid``.
-
+ **Response:** A `FacadeShowInfo` whose name is ``fcid``.
.. http:get:: <nexus>/facades
@@ -862,13 +861,25 @@ Facades
config: any;
}
+ For "taler-wire-gateway" and "anastasis" facades, ``config`` contains
+ the following type:
+
+ .. ts:def:: TalerAnastasisFacadeState
+
+ interface TalerFacadeState {
+ // Bank connection this facade relies on.
+ bankConnection: string;
+ // (Nexus local) bank account associated to this facade.
+ bankAccount: string;
+ }
+
.. http:delete:: {nexus}/facades/{fcid}
- Delete a facade.
+ Deletes a facade.
.. http:post:: {nexus}/facades
- Create a new facade.
+ Creates a new facade.
**Request:**
@@ -882,21 +893,19 @@ Facades
// For example, "taler-wire-gateway" or "anastasis".
type: string;
- // Bank accounts that the facade has read/write
- // access to.
- bankAccountsRead: string[];
- bankAccountsWrite: string[];
+ // Bank accounts that the facade has read/write access to.
+ bankAccountsRead?: string[];
+ bankAccountsWrite?: string[];
- // Bank connections that the facade has read/write
- // access to.
- bankConnectionsRead: string[];
- bankConnectionsWrite: string[];
+ // Bank connections that the facade has read/write access to.
+ bankConnectionsRead?: string[];
+ bankConnectionsWrite?: string[];
- // Facade-specific configuration details.
- config: any;
+ // Facade-specific configuration details. Only the
+ // following type is available.
+ config: TalerAnastasisFacadeState;
}
-
Bank Connection Protocols
-------------------------
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.