[taler-docs] branch master updated: circtuit API

[gnunet]

This is an automated email from the git hooks/post-receive script.

ms pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new a9179b7  circtuit API
a9179b7 is described below

commit a9179b7e2bc87311afb04879749621541204cb12
Author: MS <ms@taler.net>
AuthorDate: Thu Feb 9 17:47:30 2023 +0100

    circtuit API
    
    filter on the accounts list.
---
 libeufin/api-sandbox.rst | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
index 7ff86e0..269aee9 100644
--- a/libeufin/api-sandbox.rst
+++ b/libeufin/api-sandbox.rst
@@ -194,11 +194,17 @@ Accounts
 
 .. http:get:: /accounts
 
-   Obtains a list of all the accounts registered at the bank.
+   Obtains a list of the accounts registered at the bank.
    It returns only the information that this API handles, without
    any balance or transactions list.  The :doc:`Access API 
</core/api-bank-access>`
    offers that.  This request is only available to the administrator.
 
+   **Request:**
+
+   :query filter: *Optional.*
+     Regual expression to filter on the account username.  Without
+     this option, **all** the existing accounts are returned.
+
    **Response:**
 
    `CircuitAccounts <circuit-accounts_>`_
@@ -222,6 +228,15 @@ Accounts
 
      }
 
+   :http:statuscode:`200 OK`:
+     At least one account was found.
+
+   :http:statuscode:`204 No Content`:
+     No accounts were found for the given request.
+
+   :http:statuscode:`403 Forbidden`:
+     A ordinary user invoked this call.
+
 .. http:get:: /accounts/$username
 
    Obtains information relative to the account owned by

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.