commit 4085a5ee15f7c2629104c4c43037c71dd877d95a
parent a73972c06308e1f955902eb559ac0287a930b083
Author: Antoine A <>
Date: Tue, 6 Aug 2024 14:36:13 +0200
Fix consistency of pagination and long polling
Diffstat:
1 file changed, 5 insertions(+), 6 deletions(-)
diff --git a/core/api-bank-integration.rst b/core/api-bank-integration.rst
@@ -29,7 +29,7 @@ to tightly integrate with GNU Taler.
.. http:get:: /config
Return the protocol version and configuration information about the bank.
- This specification corresponds to ``current`` protocol being **v2**.
+ This specification corresponds to ``current`` protocol being **v3**.
**Response:**
@@ -78,13 +78,12 @@ for the withdrawal operation (the ``WITHDRAWAL_ID``) to interact with the withdr
**Request:**
- :query long_poll_ms:
- *Optional.* If specified, the bank will wait up to ``long_poll_ms``
- milliseconds for operationt state to be different from ``old_state`` before sending the HTTP
- response. A client must never rely on this behavior, as the bank may
- return a response immediately.
+ :query timeout_ms: *Optional.*
+ Timeout in milliseconds, for :ref:`long-polling <long-polling>`, to wait for operation state to be different from ``old_state``. Since protocol v3.
:query old_state:
*Optional.* Defaults to "pending".
+ :query long_poll_ms: *Optional.*
+ Deprecated in protocol v3. Use *timeout_ms* instead.
**Response:**