taler-docs

commit 3d5accf0aed02c7e667a98ebd4a375aaae75e848
parent 847d2758a121c1646f0cfbf934d4720b4b10aead
Author: Sebastian <sebasjm@gmail.com>
Date:   Mon,  6 Mar 2023 09:21:08 -0300

document api change: CircuitAccountMinimalData should include account balance

Diffstat:
M
core/api-bank-access.rst
 | 
10
++++++----
M
libeufin/api-sandbox.rst
 | 
28
+++++++++++++++++-----------

2 files changed, 23 insertions(+), 15 deletions(-)
diff --git a/core/api-bank-access.rst b/core/api-bank-access.rst
@@ -70,12 +70,14 @@ name and account password, at least in the GNU Taler demo bank implementation.
 
   .. ts:def:: BankAccountBalanceResponse
 
+    interface Balance {
+      amount: Amount;
+      credit_debit_indicator: "credit" | "debit";
+    }
+
     interface BankAccountBalanceResponse {
       // Available balance on the account.
-      balance: {
-        amount: Amount;
-        credit_debit_indicator: "credit" | "debit";
-      };
+      balance: Balance;
       // payto://-URI of the account. (New)
       paytoUri: string;
     }
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
@@ -232,20 +232,26 @@ Accounts
 
    .. ts:def:: CircuitAccounts
 
-     interfaces CircuitAccounts {
-       customers: CircuitAccountMinimalData[]; 
-     }
+      interfaces CircuitAccounts {
+        customers: CircuitAccountMinimalData[]; 
+      }
 
    .. ts:def:: CircuitAccountMinimalData
      
-     interface CircuitAccountMinimalData {
-       // Username
-       username: string;
-
-       // Legal subject owning the account.
-       name: string;
-
-     }
+      interface Balance {
+        amount: Amount;
+        credit_debit_indicator: "credit" | "debit";
+      }
+      interface CircuitAccountMinimalData {
+        // Username
+        username: string;
+
+        // Legal subject owning the account.
+        name: string;
+
+        // current balance of the account
+        balance: Balance;
+      }
 
    :http:statuscode:`200 OK`:
      At least one account was found.