gnunet-svn
[Top][All Lists]
Advanced

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

[taler-docs] branch master updated: restructure a bit to avoid confusing


From: gnunet
Subject: [taler-docs] branch master updated: restructure a bit to avoid confusing duplication of section titles:
Date: Sun, 28 Jan 2024 18:06:32 +0100

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

grothoff pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new c19624f0 restructure a bit to avoid confusing duplication of section 
titles:
c19624f0 is described below

commit c19624f05f5d6be77d74fa3bf12abed8d92df668
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Sun Jan 28 18:06:23 2024 +0100

    restructure a bit to avoid confusing duplication of section titles:
---
 core/api-corebank.rst     | 68 +++++++++++++++++++++--------------------------
 taler-merchant-manual.rst |  7 +++--
 2 files changed, 33 insertions(+), 42 deletions(-)

diff --git a/core/api-corebank.rst b/core/api-corebank.rst
index 87c4f969..d1cca6f2 100644
--- a/core/api-corebank.rst
+++ b/core/api-corebank.rst
@@ -66,7 +66,7 @@ Config
 
   **Response:**
 
-  :http:statuscode:`200 OK`: 
+  :http:statuscode:`200 OK`:
     Response is a `Config`.
 
   **Details:**
@@ -86,7 +86,7 @@ Config
       // If 'false' some parts of the API are not supported and return 501
       allow_conversion: boolean;
 
-      // If 'true' anyone can register 
+      // If 'true' anyone can register
       // If 'false' only admin can
       allow_registrations: boolean;
 
@@ -104,7 +104,7 @@ Config
 
       // Default debt limit for newly created accounts
       default_debit_threshold: Amount;
-      
+
       // Currency used by this bank.
       currency: string;
 
@@ -298,7 +298,7 @@ Account Management
 .. http:patch:: /accounts/$USERNAME/auth
 
   Allows changing the account's password.
-  
+
 
   **Request:**
 
@@ -332,13 +332,13 @@ Account Management
 
   Show those accounts whose histories are publicly visible.  For example,
   accounts from donation receivers.  As such, this request is unauthenticated.
-  
+
 
   **Request:**
 
   :query delta: *Optional.*
     Takes value of the form ``N (-N)``, so that at most ``N`` values strictly 
older (younger) than ``start`` are returned.  Defaults to ``-20`` to return the 
last 20 entries.
-  :query start: *Optional.* 
+  :query start: *Optional.*
     Row number threshold, see ``delta`` for its interpretation. Defaults to 
smallest or biggest row id possible according to ``delta`` sign.
   :query filter_name: *Optional.*
     Pattern to filter on the account legal name.  Given
@@ -388,7 +388,7 @@ Account Management
 
   :query delta: *Optional.*
     Takes value of the form ``N (-N)``, so that at most ``N`` values strictly 
older (younger) than ``start`` are returned.  Defaults to ``-20`` to return the 
last 20 entries.
-  :query start: *Optional.* 
+  :query start: *Optional.*
     Row number threshold, see ``delta`` for its interpretation. Defaults to 
smallest or biggest row id possible according to ``delta`` sign.
   :query filter_name: *Optional.*
     Pattern to filter on the account legal name.  Given
@@ -531,7 +531,7 @@ Transactions
 
   :query delta: *Optional.*
     Takes value of the form ``N (-N)``, so that at most ``N`` values strictly 
older (younger) than ``start`` are returned.  Defaults to ``-20`` to return the 
last 20 entries.
-  :query start: *Optional.* 
+  :query start: *Optional.*
     Row number threshold, see ``delta`` for its interpretation. Defaults to 
smallest or biggest row id possible according to ``delta`` sign.
   :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
@@ -697,16 +697,16 @@ Taler Withdrawals
 
   **Response:**
 
-  :http:statuscode:`204 No content`: 
+  :http:statuscode:`204 No content`:
     The withdrawal operation has been aborted.
   :http:statuscode:`404 Not found`:
     The withdrawal operation was not found.
-  :http:statuscode:`409 Conflict`: 
+  :http:statuscode:`409 Conflict`:
     The withdrawal operation has been confirmed previously and can't be 
aborted.
 
 .. http:get:: /withdrawals/$WITHDRAWAL_ID
 
-  Retrieve public information about ``WITHDRAWAL_ID`` withdrawal operation.  
+  Retrieve public information about ``WITHDRAWAL_ID`` withdrawal operation.
   Does not require further authentication as knowledge of ``WITHDRAWAL_ID``
   serves as an authenticator.
 
@@ -878,7 +878,7 @@ Cashouts
 
   :query delta: *Optional.*
     Takes value of the form ``N (-N)``, so that at most ``N`` values strictly 
older (younger) than ``start`` are returned.  Defaults to ``-20`` to return the 
last 20 entries.
-  :query start: *Optional.* 
+  :query start: *Optional.*
     Row number threshold, see ``delta`` for its interpretation. Defaults to 
smallest or biggest row id possible according to ``delta`` sign.
 
   **Response:**
@@ -915,7 +915,7 @@ Cashouts
 
   :query delta: *Optional.*
     Takes value of the form ``N (-N)``, so that at most ``N`` values strictly 
older (younger) than ``start`` are returned.  Defaults to ``-20`` to return the 
last 20 entries.
-  :query start: *Optional.* 
+  :query start: *Optional.*
     Row number threshold, see ``delta`` for its interpretation. Defaults to 
smallest or biggest row id possible according to ``delta`` sign.
 
   .. note::
@@ -980,7 +980,7 @@ Cashouts
       // Info of the last successful transmission of the TAN challenge.
       tan_info: string;
     }
-  
+
   .. ts:def:: Challenge
 
     interface Challenge {
@@ -988,7 +988,7 @@ Cashouts
       // operation.
       challenge_id: string;
     }
-  
+
   .. ts:def:: TanChannel
 
     enum TanChannel {
@@ -1025,7 +1025,7 @@ Cashouts
     * ``TALER_EC_BANK_TAN_CHALLENGE_EXPIRED`` : expired TAN.
   :http:statuscode:`429 Too many requests`:
     Too many failed confirmation attempts, a new TAN must be requested.
-  
+
 
 Monitor
 -------
@@ -1060,7 +1060,7 @@ Monitor
 
   **Response:**
 
-  :http:statuscode:`200 OK`: 
+  :http:statuscode:`200 OK`:
     The bank responds with `MonitorResponse`.
   :http:statuscode:`400 Bad Request`:
     This error may indicate that the *which* parameter is not appropriate for 
the selected *timeframe*.  For example, timeframe=month and which=20 would 
result in this error.
@@ -1073,7 +1073,7 @@ Monitor
     factors to serve different views to their users.
 
   .. ts:def:: MonitorResponse
-    
+
     // Union discriminated by the "type" field.
     type MonitorResponse =
       | MonitorNoConversion
@@ -1089,7 +1089,7 @@ Monitor
       // bank account.
       talerInCount: Integer;
 
-      // Overall volume that has been paid to a Taler 
+      // Overall volume that has been paid to a Taler
       // exchange by another bank account.
       talerInVolume: Amount;
 
@@ -1097,7 +1097,7 @@ Monitor
       // bank account.
       talerOutCount: Integer;
 
-      // Overall volume that has been paid by a Taler 
+      // Overall volume that has been paid by a Taler
       // exchange to another bank account.
       talerOutVolume: Amount;
     }
@@ -1108,7 +1108,7 @@ Monitor
     interface MonitorWithConversion {
       type: "with-conversions";
 
-      // How many cashin operations were confirmed by a 
+      // How many cashin operations were confirmed by a
       // wallet owner. Note: wallet owners
       // are NOT required to be customers of the libeufin-bank.
       cashinCount: Integer;
@@ -1136,7 +1136,7 @@ Monitor
       // bank account.
       talerInCount: Integer;
 
-      // Overall volume that has been paid to a Taler 
+      // Overall volume that has been paid to a Taler
       // exchange by another bank account.
       talerInVolume: Amount;
 
@@ -1144,14 +1144,14 @@ Monitor
       // bank account.
       talerOutCount: Integer;
 
-      // Overall volume that has been paid by a Taler 
+      // Overall volume that has been paid by a Taler
       // exchange to another bank account.
       talerOutVolume: Amount;
     }
 
 
-Taler Bank Integration API
---------------------------
+Endpoints for Integrated Sub-APIs
+---------------------------------
 
 .. http:any:: /taler-integration/*
 
@@ -1159,8 +1159,6 @@ Taler Bank Integration API
   :doc:`GNU Taler bank integration API </core/api-bank-integration>`.
   This API handles the communication with Taler wallets.
 
-Taler Wire Gateway API
-----------------------
 
 .. http:any:: /accounts/$USERNAME/taler-wire-gateway/*
 
@@ -1169,31 +1167,25 @@ Taler Wire Gateway API
 
    The endpoints are only available for accounts configured with 
``is_taler_exchange=true``.
 
-Taler Revenue API
------------------
 
 .. http:any:: /accounts/$USERNAME/taler-revenue/*
 
    All endpoints under this prefix are specified
    by the :doc:`GNU Taler Revenue API </core/api-bank-revenue>`.
 
-Taler Conversion Info API
--------------------------
 
 .. http:any:: /conversion-info/*
 
    All endpoints under this prefix are specified
    by the :doc:`GNU Taler Conversion Info API 
</core/api-bank-conversion-info>`.
 
-EBICS Host
-----------
-
-The Taler bank can be configured to serve bank account transactions and allow
-payment initiations via the EBICS protocol.
-
-This is an optional feature, not all implementations of the API support it.
 
 .. http:post:: /ebicshost
 
    EBICS base URL.  This URL allows clients to make EBICS requests to one of
    the configured EBICS hosts.
+
+   The Taler bank can be configured to serve bank account transactions and
+   allow payment initiations via the EBICS protocol.
+
+   This is an optional feature, not all implementations of the API support it.
diff --git a/taler-merchant-manual.rst b/taler-merchant-manual.rst
index 4959dd48..d2b5a675 100644
--- a/taler-merchant-manual.rst
+++ b/taler-merchant-manual.rst
@@ -273,7 +273,7 @@ the backend does not have access to the incoming wire 
transfers of the
 merchant's bank account. In this case, merchants should manually provide the
 backend with wire *transfer* data that specifies the *wire transfer subject*
 and the amount that was received. Given this information, the backend can
-detect and report any irregularities that might arise.  
+detect and report any irregularities that might arise.
 
 Rewards
 -------
@@ -774,7 +774,7 @@ interface create a file ``instance.json`` with an
 
    {
      "id" : "default",
-     "name": "example.com",
+     "name": "Example Inc.",
      "address": { "country" : "zz" },
      "auth": { "method" : "external"} ,
      "jurisdiction": { "country" : "zz" },
@@ -855,8 +855,7 @@ automatically import them into the list of wire transfers.
 Note that setting up a revenue API endpoint will usually require you to first
 ask your bank for EBICS access and to setup libeufin to provide the revenue
 API endpoint. The taler-bank used by regional currency setups also provides
-a revenue API endpoint.
-
+a revenue API endpoint at ``$BANK_URL/accounts/$ACCOUNT_NAME/taler-revenue/``.
 
 
 .. _Secure-setup:

-- 
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]