taler-docs

commit e6a667d002a63d66dfe5980ab99144d629974f1c
parent a4a1a6bbe41ec446825b18fe4888275bdff9d414
Author: ms <ms@taler.net>
Date:   Sun, 19 Mar 2023 22:15:09 +0100

pass over facade API

Diffstat:
M
libeufin/api-nexus.rst
 | 
39
++++++++++++++++++++++++---------------

1 file changed, 24 insertions(+), 15 deletions(-)
diff --git 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
 -------------------------