commit 6a6d05514267cd04fdd10bc1414a327f7aa273e8 parent c28e9e12cf6e05214b1716dd492dde1cd272085e Author: Florian Dold <florian.dold@gmail.com> Date: Tue, 19 May 2020 19:45:06 +0530 facades docs Diffstat:
| M | libeufin/api-nexus.rst | | | 41 | +++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 41 insertions(+), 0 deletions(-)
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst @@ -333,6 +333,47 @@ to the real bank. LibEuFin accounts they are connected to. +Facades +------- + +.. http:get:: <nexus>/facades + + List available facades. + +.. http:get:: <nexus>/facade/${fcid} + + Get details about a facade. + + .. ts:def:: FacadeInfo + + interface FacadeInfo { + // Name of the facade, same as the "fcid" parameter. + name: string; + + // Type of the facade. + // For example, "taler-wire-gateway". + type: string; + + // Name of the user that created the facade. + // Whenever the facade accesses a resource it is allowed to + // access, the creator must *also* have access to that resource. + creator: 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[]; + + // Facade-specific configuration details. + config: any; + } + + EBICS-specific APIs -------------------