commit c2868fced3adf4b57e30dd70e1828d2c72135cae
parent 143ad127ffe523dbfd9c0611b6eb7d0c1b02ef3c
Author: MS <ms@taler.net>
Date: Wed, 12 Apr 2023 12:06:16 +0200
Nexus API.
Extending the endpoint to get the ingested transactions.
This now offers a long polling timeout and a 'start' parameter.
Diffstat:
1 file changed, 19 insertions(+), 4 deletions(-)
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
@@ -379,12 +379,27 @@ tracks the initiations of payments.
.. http:get:: {nexusBase}/bank-accounts/{acctid}/transactions
- Shows all the transactions fetched for ``{acctid}``.
+ Shows the transactions fetched for ``{acctid}``, according to
+ the URI parameters.
- **Query parameters:**
+ **Request:**
+
+ :query long_poll_ms: Optional number to express how many milliseconds
+ the server should wait for at least one result to be shown. If not
+ given, the server responds immediately, regardless of the result.
+ :query start: Optional number to express the **earliest** transaction
+ index, starting from **1**. For example, if *start* is 6 and three
+ transactions are returned, they will have the following indexes:
+ 6, 7, 8. This parameter defaults to 1.
+ :query size: Optional number indicating how many transactions are to
+ be included in the response. It defaults to 5.
+
+ **Response:**
- **Response:** A object with a unique field named ``transactions``
- that contains a list of `Transaction` objects.
+ :http:statuscode:`200 OK`:
+ a JSON object with a unique field named ``transactions`` that
+ is a list of `Transaction` objects. This status code applies
+ even for an **empty** list.
.. ts:def:: Transaction
