[taler-docs] branch master updated: remove /exchanges API, auditor will soon be single-exchange only

[gnunet]

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 aed8524d remove /exchanges API, auditor will soon be single-exchange 
only
aed8524d is described below

commit aed8524df33feaaab47c6eba963dbbe2193505d2
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Wed Jan 10 14:51:40 2024 +0100

    remove /exchanges API, auditor will soon be single-exchange only
---
 core/api-auditor.rst | 109 +++++++++++++++------------------------------------
 1 file changed, 31 insertions(+), 78 deletions(-)

diff --git a/core/api-auditor.rst b/core/api-auditor.rst
index 12d2d611..117e1c78 100644
--- a/core/api-auditor.rst
+++ b/core/api-auditor.rst
@@ -87,60 +87,13 @@ know-your-customer (KYC) registration before issuing 
contracts.
     time of this writing).
 
 
-.. _exchange-list:
-
------------------------
-Obtaining Exchange List
------------------------
-
-This API is used by merchants to obtain a list of all exchanges audited by
-this auditor.  This may be required for the merchant to perform the required
-know-your-customer (KYC) registration before issuing contracts.
-
-.. http:get:: /exchanges
-
-  Get a list of all exchanges audited by the auditor.
-
-  **Response:**
-
-  :http:statuscode:`200 OK`:
-    The auditor responds with a :ts:type:`ExchangeList` object. This request 
should
-    virtually always be successful.
-
-  **Details:**
-
-  .. ts:def:: ExchangeList
-
-    interface ExchangeList {
-      // Exchanges audited by this auditor.
-      exchanges: ExchangeEntry[];
-    }
-
-  .. ts:def:: ExchangeEntry
-
-    interface ExchangeEntry {
-
-      // Master public key of the exchange.
-      master_pub: EddsaPublicKey;
-
-      // Base URL of the exchange.
-      exchange_url: string;
-    }
-
-  .. note::
-
-    This API is still experimental (and is not yet implemented at the
-    time of this writing). A key open question is whether the auditor
-    should sign the information. We might also want to support more
-    delta downloads in the future.
-       
 .. _exchange_signkeys-list:
 
 -----------------------
 Obtaining Exchange Signing Keys List
 -----------------------
 
-This API is used by auditor to obtain a list of all exchanges signing keys to 
be audited. 
+This API is used by auditor to obtain a list of all exchanges signing keys to 
be audited.
 
 .. http:get:: /exchange-sign-keys
 
@@ -170,13 +123,13 @@ This API is used by auditor to obtain a list of all 
exchanges signing keys to be
 
       // Base URL of the exchange.
       master_sig: EddsaSignature;
-         
+
          // Time when online signing key will first be use.
       ep_valid_from: Timestamp;
-         
+
          // Time when this online signing key will no longer be used.
       ep_expire_sign: Timestamp;
-         
+
          // Time when this online signing key legally expires.
       ep_expire_legal: Timestamp;
     }
@@ -185,14 +138,14 @@ This API is used by auditor to obtain a list of all 
exchanges signing keys to be
 
     This API is still experimental (and is not yet implemented at the
     time of this writing).
-       
+
 .. _purses-list:
 
 -----------------------
 Obtaining Purses List
 -----------------------
 
-This API is used by auditor to obtain a list of all the purses and their 
respective balances that the auditor is aware of. 
+This API is used by auditor to obtain a list of all the purses and their 
respective balances that the auditor is aware of.
 
 .. http:get:: /purses
 
@@ -202,7 +155,7 @@ This API is used by auditor to obtain a list of all the 
purses and their respect
 
   :http:statuscode:`200 OK`:
     The auditor responds with a :ts:type:`PursesList` object.
-       
+
   :http:statuscode:`204 No content`:
     No purses found.
 
@@ -221,13 +174,13 @@ This API is used by auditor to obtain a list of all the 
purses and their respect
 
       // Public online signing key of the exchange.
       purse_pub: EddsaPublicKey;
-         
+
          // Time when online signing key will first be use.
       balance: taler_amount;
-         
+
          // Time when this online signing key will no longer be used.
       target: taler_amount;
-         
+
          // Time when this online signing key legally expires.
       expiration_date: Timestamp;
     }
@@ -236,14 +189,14 @@ This API is used by auditor to obtain a list of all the 
purses and their respect
 
     This API is still experimental (and is not yet implemented at the
     time of this writing).
-       
+
 .. _purses-list:
 
 -----------------------
 Obtaining Reserves List
 -----------------------
 
-This API is used by auditor to obtain a list of all the customer reserves and 
their respective balances that the auditor is aware of. 
+This API is used by auditor to obtain a list of all the customer reserves and 
their respective balances that the auditor is aware of.
 
 .. http:get:: /reserves
 
@@ -253,7 +206,7 @@ This API is used by auditor to obtain a list of all the 
customer reserves and th
 
   :http:statuscode:`200 OK`:
     The auditor responds with a :ts:type:`ReservesList` object.
-       
+
   :http:statuscode:`204 No content`:
     No reserves found.
 
@@ -272,28 +225,28 @@ This API is used by auditor to obtain a list of all the 
customer reserves and th
 
       // Public online signing key of the reserve
       reserve_pub: EddsaPublicKey;
-         
+
          // Balance of respective reserve.
       reserve_balance: taler_amount;
-         
+
          // Loss of respective reserve.
       reserve_loss: taler_amount;
-         
+
          // Withdraw fee balance.
       withdraw_fee_balance: taler_amount;
-         
+
          // Closing fee balance.
       close_fee_balance: taler_amount;
-         
+
          // Purse fee balance.
       purse_fee_balance: taler_amount;
-         
+
          // Open fee balance.
       open_fee_balance: taler_amount;
-         
+
          // Time when this online signing key will no longer be used.
       history_fee_balance: taler_amount;
-         
+
          // Time when this reserve expires.
       expiration_date: Timestamp;
     }
@@ -302,7 +255,7 @@ This API is used by auditor to obtain a list of all the 
customer reserves and th
 
     This API is still experimental (and is not yet implemented at the
     time of this writing).
-       
+
 .. deposit-confirmation-list:
 
 -----------------------
@@ -334,7 +287,7 @@ this auditor.
   .. ts:def:: DepositConfirmation
 
     interface DepositConfirmation {
-       
+
          // Database row id of entry
          row_id: Integer;
 
@@ -484,10 +437,10 @@ This API is used by the auditor to delete an audited 
deposit confirmation.
 
   :http:statuscode:`401 Unauthorized`:
     Unauthorized request.
-       
+
   :http:statuscode:`404 Not found`:
     The deposit confirmation was already unknown.
-       
+
   :http:statuscode:`409 Conflict`:
   The deposit confirmation cannot be deleted anymore.
 
@@ -495,7 +448,7 @@ This API is used by the auditor to delete an audited 
deposit confirmation.
 
     This API is still experimental (and is not yet implemented at the
     time of this writing).
-       
+
 .. balances-list:
 
 -----------------------
@@ -538,7 +491,7 @@ this auditor.
 
     This API is still experimental (and is not yet implemented at the
     time of this writing).
-       
+
 .. denominations-pending-list:
 
 -----------------------
@@ -555,7 +508,7 @@ This API is used by the auditor to obtain a list of pending 
denominations
 
   :http:statuscode:`200 OK`:
     The auditor responds with a :ts:type:`PendingDenominationList` object.
-       
+
   :http:statuscode:`204 No content`:
     No pending demoninations found.
 
@@ -574,13 +527,13 @@ This API is used by the auditor to obtain a list of 
pending denominations
 
          // Balance of denomination.
       denom_balance: taler_amount;
-         
+
          // Amount that was lost due to failures by the exchange.
       denom_loss: taler_amount;
-         
+
          // Amount at risk of loss due to recoup operations.
       denom_risk: taler_amount;
-         
+
          // Amount actually lost due to recoup operations after a revocation.
       recoup_loss: taler_amount;
     }

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