taler-docs

commit 7f0557e09f797ee761c19f9c2b2ba2d87245edea
parent 07278834c597f9122be600aae80fa5c738da54bd
Author: Antoine A <>
Date:   Mon, 18 Dec 2023 13:39:55 +0000

Update corebank API

Diffstat:
M
core/api-bank-integration.rst
 | 
19
++++++++++++-------
M
core/api-corebank.rst
 | 
11
++++++++---

2 files changed, 20 insertions(+), 10 deletions(-)
diff --git a/core/api-bank-integration.rst b/core/api-bank-integration.rst
@@ -28,7 +28,8 @@ to tightly integrate with GNU Taler.
 
 .. http:get:: /config
 
-  Get configuration information about the bank.
+  Return the protocol version and configuration information about the bank.
+  This specification corresponds to ``current`` protocol being version **2**.
 
   **Response:**
 
@@ -41,6 +42,9 @@ to tightly integrate with GNU Taler.
   .. ts:def:: IntegrationConfig
 
     interface IntegrationConfig {
+      // Name of the API.
+      name: "taler-bank-integration";
+
       // libtool-style representation of the Bank protocol version, see
       // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
       // The format is "current:revision:age".
@@ -51,9 +55,6 @@ to tightly integrate with GNU Taler.
 
       // How the bank SPA should render this currency.
       currency_specification: CurrencySpecification;
-
-      // Name of the API.
-      name: "taler-bank-integration";
     }
 
 
@@ -98,6 +99,7 @@ for the withdrawal operation (the ``WITHDRAWAL_ID``) to interact with the withdr
       // selected: the operations has been selected and is pending confirmation
       // aborted: the operation has been aborted
       // confirmed: the transfer has been confirmed and registered by the bank
+      // Since protocol v1.
       status: "pending" | "selected" | "aborted" | "confirmed";
 
       // Amount that will be withdrawn with this operation
@@ -121,23 +123,25 @@ for the withdrawal operation (the ``WITHDRAWAL_ID``) to interact with the withdr
 
       // Reserve public key selected by the exchange,
       // only non-null if ``status`` is ``selected`` or ``confirmed``.
+      // Since protocol v1.
       selected_reserve_pub?: string;
 
       // Exchange account selected by the wallet
       // only non-null if ``status`` is ``selected`` or ``confirmed``.
+      // Since protocol v1.
       selected_exchange_account?: string;
 
-      // Deprecated field use ``status`` instead
+      // Deprecated field since protocol v1 use ``status`` instead
       // Indicates whether the withdrawal was aborted.
       aborted: boolean;
 
-      // Deprecated field use ``status`` instead
+      // Deprecated field since protocol v1 use ``status`` instead
       // Has the wallet selected parameters for the withdrawal operation
       // (exchange and reserve public key) and successfully sent it
       // to the bank?
       selection_done: boolean;
 
-      // Deprecated field use ``status`` instead
+      // Deprecated field since protocol v1 use ``status`` instead
       // The transfer has been confirmed and registered by the bank.
       // Does not guarantee that the funds have arrived at the exchange already.
       transfer_done: boolean;
@@ -200,6 +204,7 @@ for the withdrawal operation (the ``WITHDRAWAL_ID``) to interact with the withdr
 
   Aborts ``WITHDRAWAL_ID`` operation.  Has no effect on an already aborted
   operation.
+  Since protocol v2.
 
   **Response:**
 
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
@@ -61,6 +61,9 @@ Config
 
 .. http:get:: /config
 
+  Return the protocol version and configuration information about the bank.
+  This specification corresponds to ``current`` protocol being version **3**.
+
   **Response:**
 
   :http:statuscode:`200 OK`: 
@@ -78,10 +81,12 @@ Config
   .. ts:def:: Config
 
     interface Config {
-      // Name of this API, always "taler-corebank".
-      name: string;
+      // Name of the API.
+      name: "taler-corebank";
 
-      // API version in the form $n:$n:$n
+      // libtool-style representation of the Bank protocol version, see
+      // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
+      // The format is "current:revision:age".
       version: string;
 
       // If 'true' the server provides local currency conversion support