gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[taler-docs] branch master updated (8d646b89 -> ea8a90a9)


From: gnunet
Subject: [taler-docs] branch master updated (8d646b89 -> ea8a90a9)
Date: Fri, 03 Jan 2025 21:24:47 +0100

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

grothoff pushed a change to branch master
in repository docs.

    from 8d646b89 deprecate
     new 02c8f34a added no_amount_to_wallet to Core Bank API spec
     new ea8a90a9 improve spec for 'no_amount_to_wallet' flag

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 core/api-bank-integration.rst |  12 ++-
 core/api-corebank.rst         | 192 +++++++++++++++++++++++-------------------
 2 files changed, 116 insertions(+), 88 deletions(-)

diff --git a/core/api-bank-integration.rst b/core/api-bank-integration.rst
index ed05f1b2..e8257157 100644
--- 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 **v4**.
+  This specification corresponds to ``current`` protocol being **v5**.
 
   **Response:**
 
@@ -63,6 +63,8 @@ to tightly integrate with GNU Taler.
     }
 
 
+.. _wallet-wopid-withdrawing:
+
 -----------
 Withdrawing
 -----------
@@ -174,6 +176,14 @@ for the withdrawal operation (the ``WITHDRAWAL_ID``) to 
interact with the withdr
       // @since **v1**
       selected_exchange_account?: string;
 
+      // If true, tells the wallet not to allow the user to
+      // specify an amount to withdraw and to not provide
+      // any amount when registering with the withdrawal
+      // operation. The amount to withdraw will be set
+      // by the final ``/withdrawals/$WITHDRAWAL_ID/confirm`` step.
+      // @since **v5**
+      no_amount_to_wallet?: bool;
+
       // @deprecated since **v1**, use ``status`` instead
       // Indicates whether the withdrawal was aborted.
       aborted: boolean;
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
index 81c7fb2b..4cb561b4 100644
--- a/core/api-corebank.rst
+++ b/core/api-corebank.rst
@@ -32,6 +32,94 @@ The Libeufin bank provides a minimal core banking system.  
In addition to that,
 it provides features for local/regional currencies.
 
 
+Config
+------
+
+.. http:get:: /config
+
+  Return the protocol version and configuration information about the bank.
+  This specification corresponds to ``current`` protocol being version **v8**.
+
+  **Response:**
+
+  :http:statuscode:`200 OK`:
+    Response is a `Config`.
+
+  **Details:**
+
+  .. ts:def:: Config
+
+    interface Config {
+      // Name of the API.
+      name: "taler-corebank";
+
+      // 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;
+
+      // Bank display name to be used in user interfaces.
+      // For consistency use "Taler Bank" if missing.
+      // @since **v4**, will become mandatory in the next version.
+      bank_name?: string;
+
+      // Advertised base URL to use when you sharing an URL with another
+      // program.
+      // @since **v4**.
+      base_url?: string;
+
+      // If 'true' the server provides local currency conversion support
+      // If 'false' some parts of the API are not supported and return 501
+      allow_conversion: boolean;
+
+      // If 'true' anyone can register
+      // If 'false' only admin can
+      allow_registrations: boolean;
+
+      // If 'true' account can delete themselves
+      // If 'false' only admin can delete accounts
+      allow_deletions: boolean;
+
+      // If 'true' anyone can edit their name
+      // If 'false' only admin can
+      allow_edit_name: boolean;
+
+      // If 'true' anyone can edit their cashout account
+      // If 'false' only admin can
+      allow_edit_cashout_payto_uri: boolean;
+
+      // Default debt limit for newly created accounts
+      default_debit_threshold: Amount;
+
+      // Currency used by this bank.
+      currency: string;
+
+      // How the bank SPA should render this currency.
+      currency_specification: CurrencySpecification;
+
+      // TAN channels supported by the server
+      supported_tan_channels: TanChannel[];
+
+      // Wire transfer type supported by the bank.
+      // Defaults to 'iban' is missing
+      // @since **v4**, will become mandatory in the next version.
+      wire_type?: string;
+
+      // Wire transfer execution fees. Only applies to bank transactions and 
withdrawals.
+      // @since **v4**, will become mandatory in the next version.
+      wire_transfer_fees?: Amount;
+
+      // Minimum wire transfer amount allowed. Only applies to bank 
transactions and withdrawals.
+      // @since **v4**, will become mandatory in the next version.
+      min_wire_transfer_amount?: Amount;
+
+      // Maximum wire transfer amount allowed. Only applies to bank 
transactions and withdrawals.
+      // @since **v4**, will become mandatory in the next version.
+      max_wire_transfer_amount?: Amount;
+    }
+
+
+
 Authentication
 --------------
 
@@ -179,92 +267,6 @@ Bank Web UI
 
 The web UI for the bank is typically served under ``/``.
 
-Config
-------
-
-.. http:get:: /config
-
-  Return the protocol version and configuration information about the bank.
-  This specification corresponds to ``current`` protocol being version **v7**.
-
-  **Response:**
-
-  :http:statuscode:`200 OK`:
-    Response is a `Config`.
-
-  **Details:**
-
-  .. ts:def:: Config
-
-    interface Config {
-      // Name of the API.
-      name: "taler-corebank";
-
-      // 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;
-
-      // Bank display name to be used in user interfaces.
-      // For consistency use "Taler Bank" if missing.
-      // @since **v4**, will become mandatory in the next version.
-      bank_name?: string;
-
-      // Advertised base URL to use when you sharing an URL with another
-      // program.
-      // @since **v4**.
-      base_url?: string;
-
-      // If 'true' the server provides local currency conversion support
-      // If 'false' some parts of the API are not supported and return 501
-      allow_conversion: boolean;
-
-      // If 'true' anyone can register
-      // If 'false' only admin can
-      allow_registrations: boolean;
-
-      // If 'true' account can delete themselves
-      // If 'false' only admin can delete accounts
-      allow_deletions: boolean;
-
-      // If 'true' anyone can edit their name
-      // If 'false' only admin can
-      allow_edit_name: boolean;
-
-      // If 'true' anyone can edit their cashout account
-      // If 'false' only admin can
-      allow_edit_cashout_payto_uri: boolean;
-
-      // Default debt limit for newly created accounts
-      default_debit_threshold: Amount;
-
-      // Currency used by this bank.
-      currency: string;
-
-      // How the bank SPA should render this currency.
-      currency_specification: CurrencySpecification;
-
-      // TAN channels supported by the server
-      supported_tan_channels: TanChannel[];
-
-      // Wire transfer type supported by the bank.
-      // Defaults to 'iban' is missing
-      // @since **v4**, will become mandatory in the next version.
-      wire_type?: string;
-
-      // Wire transfer execution fees. Only applies to bank transactions and 
withdrawals.
-      // @since **v4**, will become mandatory in the next version.
-      wire_transfer_fees?: Amount;
-
-      // Minimum wire transfer amount allowed. Only applies to bank 
transactions and withdrawals.
-      // @since **v4**, will become mandatory in the next version.
-      min_wire_transfer_amount?: Amount;
-
-      // Maximum wire transfer amount allowed. Only applies to bank 
transactions and withdrawals.
-      // @since **v4**, will become mandatory in the next version.
-      max_wire_transfer_amount?: Amount;
-    }
-
 
 Account Management
 ------------------
@@ -914,6 +916,14 @@ Account withdrawals
       // still change the suggestion.
       // @since **v6**
       suggested_amount?: Amount;
+
+      // If true, tell the wallet not to allow the user to
+      // specify an amount to withdraw and to not provide
+      // any amount when registering with the withdrawal
+      // operation. The amount to withdraw will be set
+      // by the final ``/withdrawals/$WITHDRAWAL_ID/confirm`` step.
+      // @since **v8**
+      no_amount_to_wallet?: bool;
     }
 
   .. ts:def:: BankAccountCreateWithdrawalResponse
@@ -1028,6 +1038,14 @@ Account withdrawals
       // Optional since **v6**.
       suggested_amount?: Amount;
 
+      // If true, the wallet must not allow the user to
+      // specify an amount to withdraw and to not provide
+      // any amount when registering with the withdrawal
+      // operation. The amount to withdraw will be set
+      // by the final ``/withdrawals/$WITHDRAWAL_ID/confirm`` step.
+      // @since **v8**
+      no_amount_to_wallet?: bool;
+
       // Account username
       username: string;
 
@@ -1318,7 +1336,7 @@ Cashouts
   Solves the ``CHALLENGE_ID`` challenge and allows performing the protected 
operation.
 
   When the challenge is confirmed, you can call the protected endpoint again 
with ``CHALLENGE_ID`` in the ``X-Challenge-Id`` HTTP header and an empty 
request body.
-  
+
   This endpoints is not authenticated for token creation challenges. Too many 
unsuccessful attempts to confirm token creation challenges block the account.
 
   **Request:**

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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]