diff options
| -rw-r--r-- | libeufin/api-nexus.rst | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst index 64fc48e5..0fd08743 100644 --- a/libeufin/api-nexus.rst +++ b/libeufin/api-nexus.rst @@ -675,13 +675,18 @@ to the real bank. Facades ------- +.. http:get:: <nexus>/facades/{fcid} + + **Response:** A `FacadeShowInfo` pointed to by ``fcid``. + + .. http:get:: <nexus>/facades List available facades that belong to the requesting user. **Response:** A list of the following elements: - .. code-block:: ts +.. ts:def:: FacadeShowInfo interface FacadeShowInfo { @@ -694,17 +699,18 @@ Facades // Bas URL of the facade. baseUrl: string; + + // details depending on the facade type. + config: any; } .. http:post:: {nexus}/facades - Create a new facade; it requires a `FacadeInfo` as the request's body. - -.. http:get:: {nexus}/facades/${fcid} + Create a new facade. - Get details about a facade. + **Request:** - .. ts:def:: FacadeInfo + .. code-block:: ts interface FacadeInfo { // Name of the facade, same as the "fcid" parameter. |