[taler-docs] branch master updated: Add some descriptions

[gnunet]

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

cedric-zwahlen pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new fe4c6b8d Add some descriptions
fe4c6b8d is described below

commit fe4c6b8d72d8077bacdd536665884a958cbeebec
Author: Cedric Zwahlen <cedric.zwahlen@students.bfh.ch>
AuthorDate: Thu May 30 11:31:38 2024 +0200

    Add some descriptions
---
 core/api-auditor.rst | 112 ++++++++++++++++++++++-----------------------------
 1 file changed, 49 insertions(+), 63 deletions(-)

diff --git a/core/api-auditor.rst b/core/api-auditor.rst
index 83050052..d409685d 100644
--- a/core/api-auditor.rst
+++ b/core/api-auditor.rst
@@ -299,7 +299,7 @@ This usually means that a start date of a fee is set to a 
later date than its en
 
 This API is used to suppress select elements of fee time inconsistencies
 
-.. http:patch:: /fee-time-inconsistency/$SERIAL_ID
+.. http:patch:: /monitoring/fee-time-inconsistency/$SERIAL_ID
 
   Update the 'suppressed' field of a fee time inconsistency element with 
row_id $SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -396,7 +396,7 @@ compromise.
 
 This API is used to suppress select elements of emergencies by count
 
-.. http:patch:: /emergency-by-count/$SERIAL_ID
+.. http:patch:: /monitoring/emergency-by-count/$SERIAL_ID
 
   Update the 'suppressed' field of an emergency by count element with row_id 
$SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -479,7 +479,7 @@ inconsistency is noted in 'diagnostic'.
 
 This API is used to suppress select elements of row inconsistencies
 
-.. http:patch:: /row-inconsistency/$SERIAL_ID
+.. http:patch:: /monitoring/row-inconsistency/$SERIAL_ID
 
   Update the 'suppressed' field of a row inconsistency element with row_id 
$SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -500,7 +500,10 @@ This API is used to suppress select elements of row 
inconsistencies
 Reserve In Inconsistencies
 --------------------------
 
-This API is used to obtain a list of reserve in inconsistencies
+This section lists cases where the exchange's and auditor's expectation of 
amounts transerred
+into a reserve differs. 
+
+#FIXME: not sure if this is accurate
 
 .. http:get:: /monitoring/reserve-in-inconsistency
 
@@ -563,7 +566,7 @@ This API is used to obtain a list of reserve in 
inconsistencies
 
 This API is used to suppress select elements of reserve in inconsistencies
 
-.. http:patch:: /reserve-in-inconsistency/$SERIAL_ID
+.. http:patch:: /monitoring/reserve-in-inconsistency/$SERIAL_ID
 
   Update the 'suppressed' field of a reserve in inconsistency element with 
row_id $SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -645,7 +648,7 @@ causing a purse – which may contain some currency – to 
expire.
 
 This API is used to suppress select elements of purse not closed 
inconsistencies
 
-.. http:patch:: /purse-not-closed-inconsistencies/$SERIAL_ID
+.. http:patch:: /monitoring/purse-not-closed-inconsistencies/$SERIAL_ID
 
   Update the 'suppressed' field of a purse not closed inconsistencies element 
with row_id $SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the 
auditor.
 
@@ -725,7 +728,7 @@ This section highlights cases, in which reserves were not 
closed, despite being
 
 This API is used to suppress select elements of reserve not closed 
inconsistencies
 
-.. http:patch:: /reserve-not-closed-inconsistency/$SERIAL_ID
+.. http:patch:: /monitoring/reserve-not-closed-inconsistency/$SERIAL_ID
 
   Update the 'suppressed' field of a reserve not closed inconsistency element 
with row_id $SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the 
auditor.
 
@@ -807,7 +810,7 @@ compromise resulting in proportional financial losses to 
the exchange.
 
 This API is used to suppress select elements of reserve balance insufficient 
inconsistencies
 
-.. http:patch:: /reserve-balance-insufficient-inconsistency/$SERIAL_ID
+.. http:patch:: 
/monitoring/reserve-balance-insufficient-inconsistency/$SERIAL_ID
 
   Update the 'suppressed' field of a reserve balance insufficient 
inconsistency element with row_id $SERIAL_ID, according to 
:ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -889,7 +892,7 @@ invalid and the amount involved should be considered lost.
 
 This API is used to suppress select elements of bad sig losses
 
-.. http:patch:: /bad-sig-losses/$SERIAL_ID
+.. http:patch:: /monitoring/bad-sig-losses/$SERIAL_ID
 
   Update the 'suppressed' field of a bad sig losses element with row_id 
$SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -910,18 +913,16 @@ This API is used to suppress select elements of bad sig 
losses
 Coin Inconsistencies
 --------------------
 
-This API is used to obtain a list of coin inconsistencies
+This section lists cases where the exchange made arithmetic errors found when
+looking at the transaction history of a coin.  The totals sum up the 
differences
+in amounts that matter for profit/loss calculations of the exchange. When an
+exchange merely shifted money from customers to merchants (or vice versa) 
without
+any effects on its own balance, those entries are excluded from the total.
 
 .. http:get:: /monitoring/coin-inconsistency
 
   Get a list of coin inconsistencies stored by the auditor.
 
-  This section lists cases where the exchange made arithmetic errors found when
-  looking at the transaction history of a coin.  The totals sum up the 
differences
-  in amounts that matter for profit/loss calculations of the exchange. When an
-  exchange merely shifted money from customers to merchants (or vice versa) 
without
-  any effects on its own balance, those entries are excluded from the total.
-
   The following query parameters are optional, and can be used to customise 
the response:
 
   **Request:**
@@ -977,7 +978,7 @@ This API is used to obtain a list of coin inconsistencies
 
 This API is used to suppress select elements of coin inconsistencies
 
-.. http:patch:: /coin-inconsistency/$SERIAL_ID
+.. http:patch:: /monitoring/coin-inconsistency/$SERIAL_ID
 
   Update the 'suppressed' field of a coin inconsistency element with row_id 
$SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -1058,7 +1059,7 @@ purse balances.
 
 This API is used to suppress select elements of balances
 
-.. http:patch:: /balances/$SERIAL_ID
+.. http:patch:: /monitoring/balances/$SERIAL_ID
 
   Update the 'suppressed' field of a balances element with row_id $SERIAL_ID, 
according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -1143,7 +1144,7 @@ business situation.
 
 This API is used to suppress select elements of denominations without sigs
 
-.. http:patch:: /denominations-without-sigs/$SERIAL_ID
+.. http:patch:: /monitoring/denominations-without-sigs/$SERIAL_ID
 
   Update the 'suppressed' field of a denominations without signatures element 
with row_id $SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the 
auditor.
 
@@ -1227,7 +1228,7 @@ account.
 
 This API is used to suppress select elements of misattribution in 
inconsistencies
 
-.. http:patch:: /misattribution-in-inconsistency/$SERIAL_ID
+.. http:patch:: /monitoring/misattribution-in-inconsistency/$SERIAL_ID
 
   Update the 'suppressed' field of an misattribution in inconsistency element 
with row_id $SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the 
auditor.
 
@@ -1250,6 +1251,8 @@ Reserves
 
 This API is used to obtain a list of reserves 
 
+#FIXME: this is missing some information
+
 .. http:get:: /monitoring/reserves
 
   Get a list of reserves stored by the auditor.
@@ -1319,7 +1322,7 @@ This API is used to obtain a list of reserves
 
 This API is used to suppress select elements of reserves
 
-.. http:patch:: /reserves/$SERIAL_ID
+.. http:patch:: /monitoring/reserves/$SERIAL_ID
 
   Update the 'suppressed' field of an reserves element with row_id $SERIAL_ID, 
according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -1340,7 +1343,8 @@ This API is used to suppress select elements of reserves
 Deposit Confirmations
 ---------------------
 
-This API is used to obtain a list of deposit confirmations
+This section contains a list of deposits the merchant made to the exchange, 
provided by a merchant.
+This list can be cross-referenced with the exchanges deposits; any 
discrepancies could be a sign of misbehaviour.
 
 .. http:get:: /monitoring/deposit-confirmations
 
@@ -1419,7 +1423,7 @@ This API is used to obtain a list of deposit confirmations
 
 This API is used to suppress select elements of deposit confirmations
 
-.. http:patch:: /deposit-confirmations/$SERIAL_ID
+.. http:patch:: /monitoring/deposit-confirmations/$SERIAL_ID
 
   Update the 'suppressed' field of an deposit confirmations element with 
row_id $SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -1433,31 +1437,6 @@ This API is used to suppress select elements of deposit 
confirmations
     This API is still experimental. The API will be further developed as 
needed.
 
 
-
-
-This API is used by the auditor to delete an audited deposit confirmation.
-
-.. http:delete:: /deposit-confirmation/$SERIAL_ID
-
-  Delete deposit confirmation entry with given serial_id.
-
-  **Response:**
-
-  :http:statuscode:`204 No content`:
-    The deposit confirmation was deleted.
-
-  :http:statuscode:`401 Unauthorized`:
-    Unauthorized request.
-
-  :http:statuscode:`404 Not found`:
-    The deposit confirmation was unknown.
-
-  .. note::
-
-    This API is still experimental (and is not yet implemented at the
-    time of this writing).
-
-
 .. denomination-key-validity-withdraw-inconsistency-list:
 
 Denomination Key Validity Withdraw Inconsistencies
@@ -1523,7 +1502,7 @@ after they were already expired.
 
 This API is used to suppress select elements of denomination key validity 
withdraw inconsistencies
 
-.. http:patch:: /denomination-key-validity-withdraw-inconsistency/$SERIAL_ID
+.. http:patch:: 
/monitoring/denomination-key-validity-withdraw-inconsistency/$SERIAL_ID
 
   Update the 'suppressed' field of a denomination key validity withdraw 
inconsistency element with row_id $SERIAL_ID, according to 
:ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -1606,7 +1585,7 @@ not match the balance an exchange expects it to be.
 
 This API is used to suppress select elements of purses
 
-.. http:patch:: /purses/$SERIAL_ID
+.. http:patch:: /monitoring/purses/$SERIAL_ID
 
   Update the 'suppressed' field of a purses element with row_id $SERIAL_ID, 
according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -1695,7 +1674,7 @@ the exchange.
 
 This API is used to suppress select elements of amount arithmetic 
inconsistencies
 
-.. http:patch:: /amount-arithmetic-inconsistency/$SERIAL_ID
+.. http:patch:: /monitoring/amount-arithmetic-inconsistency/$SERIAL_ID
 
   Update the 'suppressed' field of an amount arithmetic inconsistency element 
with row_id $SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the 
auditor.
 
@@ -1718,6 +1697,8 @@ Historic Denomination Revenue
 
 This API is used to obtain a list of historic denomination revenue
 
+#FIXME: this is missing some information
+
 .. http:get:: /monitoring/historic-denomination-revenue
 
   Get a list of historic denomination revenue stored by the auditor.
@@ -1773,7 +1754,7 @@ This API is used to obtain a list of historic 
denomination revenue
 
 This API is used to suppress select elements of historic denomination revenue
 
-.. http:patch:: /historic-denomination-revenue/$SERIAL_ID
+.. http:patch:: /monitoring/historic-denomination-revenue/$SERIAL_ID
 
   Update the 'suppressed' field of a historic denomination revenue element 
with row_id $SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the 
auditor.
 
@@ -1796,6 +1777,8 @@ Denomination Pending
 
 This API is used to obtain a list of denomination pending
 
+#FIXME: this is missing some information
+
 .. http:get:: /monitoring/denomination-pending
 
   Get a list of denomination pending stored by the auditor.
@@ -1855,7 +1838,7 @@ This API is used to obtain a list of denomination pending
 
 This API is used to suppress select elements of denomination pending
 
-.. http:patch:: /denomination-pending/$SERIAL_ID
+.. http:patch:: /monitoring/denomination-pending/$SERIAL_ID
 
   Update the 'suppressed' field of a denomination pending element with row_id 
$SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -1934,7 +1917,7 @@ differs from its actual summary.
 
 This API is used to suppress select elements of historic reserve summary
 
-.. http:patch:: /historic-reserve-summary/$SERIAL_ID
+.. http:patch:: /monitoring/historic-reserve-summary/$SERIAL_ID
 
   Update the 'suppressed' field of a historic reserve summary element with 
row_id $SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -1957,6 +1940,8 @@ Exchange Signkeys
 
 This API is used to obtain a list of exchange signkeys
 
+#FIXME: this is missing some information
+
 .. http:get:: /monitoring/exchange-signkeys
 
   Get a list of exchange signkeys stored by the auditor.
@@ -2014,7 +1999,7 @@ This API is used to obtain a list of exchange signkeys
 
 This API is used to suppress select elements of exchange signkeys
 
-.. http:patch:: /exchange-signkeys/$SERIAL_ID
+.. http:patch:: /monitoring/exchange-signkeys/$SERIAL_ID
 
   Update the 'suppressed' field of an exchange signkeys element with row_id 
$SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -2092,7 +2077,7 @@ This section highlights cases, where the format of a wire 
transaction was malfor
 
 This API is used to suppress select elements of wire format inconsistencies
 
-.. http:patch:: /wire-format-inconsistency/$SERIAL_ID
+.. http:patch:: /monitoring/wire-format-inconsistency/$SERIAL_ID
 
   Update the 'suppressed' field of a wire format inconsistency element with 
row_id $SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -2172,7 +2157,7 @@ the auditor.
 
 This API is used to suppress select elements of refreshes hanging
 
-.. http:patch:: /refreshes-hanging/$SERIAL_ID
+.. http:patch:: /monitoring/refreshes-hanging/$SERIAL_ID
 
   Update the 'suppressed' field of a refreshes hanging element with row_id 
$SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -2267,7 +2252,7 @@ compromise.
 
 This API is used to suppress select elements of emergencies
 
-.. http:patch:: /emergency/$SERIAL_ID
+.. http:patch:: /monitoring/emergency/$SERIAL_ID
 
   Update the 'suppressed' field of an emergency element with row_id 
$SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -2354,7 +2339,7 @@ load. Small amounts of lag can occur in normal operation.
 
 This API is used to suppress select elements of closure lags
 
-.. http:patch:: /closure-lags/$SERIAL_ID
+.. http:patch:: /monitoring/closure-lags/$SERIAL_ID
 
   Update the 'suppressed' field of a closure lags element with row_id 
$SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -2433,7 +2418,7 @@ outgoing wire transfers does not match with that of the 
bank.
 
 This API is used to suppress select elements of wire out inconsistencies
 
-.. http:patch:: /wire-out-inconsistency/$SERIAL_ID
+.. http:patch:: /monitoring/wire-out-inconsistency/$SERIAL_ID
 
   Update the 'suppressed' field of a wire out inconsistency element with 
row_id $SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -2454,7 +2439,8 @@ This API is used to suppress select elements of wire out 
inconsistencies
 Reserve Balance Summary Wrong Inconsistencies
 ---------------------------------------------
 
-This API is used to obtain a list of reserve balance summary wrong 
inconsistencies
+This section highlights cases, where the exchange's and auditors' 
+expectation of the amount of money in a reserve differs.
 
 .. http:get:: /monitoring/reserve-balance-summary-wrong-inconsistency
 
@@ -2511,7 +2497,7 @@ This API is used to obtain a list of reserve balance 
summary wrong inconsistenci
 
 This API is used to suppress select elements of reserve balance summary wrong 
inconsistencies
 
-.. http:patch:: /reserve-balance-summary-wrong-inconsistency/$SERIAL_ID
+.. http:patch:: 
/monitoring/reserve-balance-summary-wrong-inconsistency/$SERIAL_ID
 
   Update the 'suppressed' field of a reserve balance summary wrong 
inconsistency element with row_id $SERIAL_ID, according to 
:ts:type:`GenericUpdate`, stored by the auditor.
 
@@ -2590,7 +2576,7 @@ but not necessarily point to a monetary loss (yet).
 
 This API is used to suppress select elements of row minor inconsistencies
 
-.. http:patch:: /row-minor-inconsistencies/$SERIAL_ID
+.. http:patch:: /monitoring/row-minor-inconsistencies/$SERIAL_ID
 
   Update the 'suppressed' field of a row minor inconsistencies element with 
row_id $SERIAL_ID, according to :ts:type:`GenericUpdate`, stored by the auditor.
 

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