commit 2bf59afa54f9e0d777b0fa206585d02088696e81
parent 3a7eb50ac3ca10b1d45d59e00be1271c98f96ad2
Author: Cedric Zwahlen <cedric.zwahlen@students.bfh.ch>
Date: Mon, 20 May 2024 21:10:38 +0200
Improve api-auditor doc
Diffstat:
| M | core/api-auditor.rst | | | 1207 | ++++++++++++++++++------------------------------------------------------------- |
1 file changed, 278 insertions(+), 929 deletions(-)
diff --git a/core/api-auditor.rst b/core/api-auditor.rst
@@ -97,12 +97,149 @@ know-your-customer (KYC) registration before issuing contracts.
time of this writing).
+.. _deposit-confirmation:
+
+---------------------
+Deposit Confirmations
+---------------------
+
+Merchants should probabilistically submit some of the deposit
+confirmations they receive from the exchange to auditors to ensure
+that the exchange does not lie about recording deposit confirmations
+with the exchange. Participating in this scheme ensures that in case
+an exchange runs into financial trouble to pay its obligations, the
+merchants that did participate in detecting the bad behavior can be
+paid out first.
+
+.. http:put:: /deposit-confirmation
+
+ Submits a `DepositConfirmation` to the exchange. Should succeed
+ unless the signature provided is invalid or the exchange is not
+ audited by this auditor.
+
+ **Response:**
+
+ :http:statuscode:`200 Ok`:
+ The auditor responds with a `DepositAudited` object.
+ This request should virtually always be successful.
+ :http:statuscode:`403 Forbidden`:
+ The signature on the deposit confirmation is invalid.
+ :http:statuscode:`410 Gone`:
+ The public key used to sign the deposit confirmation
+ was revoked.
+
+ **Details:**
+
+ .. ts:def:: DepositAudited
+
+ interface DepositAudited {
+ // TODO: maybe change to ``204 No content`` instead?
+ }
+
+ .. ts:def:: DepositConfirmation
+
+ interface DepositConfirmation {
+
+ // Hash over the contract for which this deposit is made.
+ h_contract_terms: HashCode;
+
+ // Hash over the extensions.
+ h_extensions: HashCode;
+
+ // Hash over the wiring information of the merchant.
+ h_wire: HashCode;
+
+ // Time when the deposit confirmation confirmation was generated.
+ timestamp: Timestamp;
+
+ // How much time does the merchant have to issue a refund
+ // request? Zero if refunds are not allowed.
+ refund_deadline: Timestamp;
+
+ // By what time does the exchange have to wire the funds?
+ wire_deadline: Timestamp;
+
+ // Amount to be deposited, excluding fee. Calculated from the
+ // amount with fee and the fee from the deposit request.
+ amount_without_fee: Amount;
+
+ // Array of public keys of the deposited coins.
+ coin_pubs: EddsaPublicKey[];
+
+ // Array of deposit signatures of the deposited coins.
+ // Must have the same length as ``coin_pubs``.
+ coin_sigs: EddsaSignature[];
+
+ // The Merchant's public key. Allows the merchant to later refund
+ // the transaction or to inquire about the wire transfer identifier.
+ merchant_pub: EddsaPublicKey;
+
+ // Signature from the exchange of type
+ // ``TALER_SIGNATURE_EXCHANGE_CONFIRM_DEPOSIT``.
+ exchange_sig: EddsaSignature;
+
+ // Public signing key from the exchange matching ``exchange_sig``.
+ exchange_pub: EddsaPublicKey;
+
+ // Master public key of the exchange corresponding to ``master_sig``.
+ // Identifies the exchange this is about.
+ // @deprecated since v1 (now ignored, global per auditor)
+ master_pub: EddsaPublicKey;
+
+ // When does the validity of the exchange_pub end?
+ ep_start: Timestamp;
+
+ // When will the exchange stop using the signing key?
+ ep_expire: Timestamp;
+
+ // When does the validity of the exchange_pub end?
+ ep_end: Timestamp;
+
+ // Exchange master signature over ``exchange_sig``.
+ master_sig: EddsaSignature;
+ }
+
+ .. 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 response information.
+
+
+.. _spa-api:
+
+---------------------------
+Single Page Application API
+---------------------------
+
+The following entries specify how to access the results of an audit.
+
+For most endpoints, rows may be marked as 'suppressed', to not send them again upon subsequent GET requests.
+To do this, a :ts:type:`GenericUpdate` object may be used.
+
+**Details:**
+
+ .. ts:def:: GenericUpdate
+
+ interface GenericUpdate {
+
+ // the row_id of a respective table that should be changed
+ row_id : Integer;
+
+ // if true, subsequent GET requests will not, by default, receive the row specified in row_id.
+ suppressed : boolean;
+
+ // unused
+ ancient? : boolean;
+
+ }
+
+
.. fee-time-inconsistency-list:
---------------------------------------------
-Obtaining a list of fee time inconsistencies
---------------------------------------------
+Fee Time Inconsistencies
+------------------------
This API is used to obtain a list of fee time inconsistencies
@@ -159,12 +296,6 @@ This API is used to obtain a list of fee time inconsistencies
-.. fee-time-inconsistency-update:
-
------------------------------------------------
-Supressing elements of fee time inconsistencies
------------------------------------------------
-
This API is used to suppress select elements of fee time inconsistencies
.. http:patch:: /fee-time-inconsistency
@@ -173,29 +304,8 @@ This API is used to suppress select elements of fee time inconsistencies
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -206,15 +316,14 @@ This API is used to suppress select elements of fee time inconsistencies
.. emergency-by-count-list:
---------------------------------------
-Obtaining a list of emergency by count
---------------------------------------
+Emergencies By Count
+--------------------
-This API is used to obtain a list of emergency by count
+This API is used to obtain a list of emergencies by count
.. http:get:: /emergency-by-count
- Get a list of emergency by count stored by the auditor.
+ Get a list of emergencies by count stored by the auditor.
The following query parameters are optional, and can be used to customise the response:
@@ -273,13 +382,7 @@ This API is used to obtain a list of emergency by count
-.. emergency-by-count-update:
-
------------------------------------------
-Supressing elements of emergency by count
------------------------------------------
-
-This API is used to suppress select elements of emergency by count
+This API is used to suppress select elements of emergencies by count
.. http:patch:: /emergency-by-count
@@ -287,29 +390,8 @@ This API is used to suppress select elements of emergency by count
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -320,9 +402,8 @@ This API is used to suppress select elements of emergency by count
.. row-inconsistency-list:
----------------------------------------
-Obtaining a list of row inconsistencies
----------------------------------------
+Row Inconsistencies
+-------------------
This API is used to obtain a list of row inconsistencies
@@ -377,12 +458,6 @@ This API is used to obtain a list of row inconsistencies
-.. row-inconsistency-update:
-
-------------------------------------------
-Supressing elements of row inconsistencies
-------------------------------------------
-
This API is used to suppress select elements of row inconsistencies
.. http:patch:: /row-inconsistency
@@ -391,29 +466,8 @@ This API is used to suppress select elements of row inconsistencies
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -424,9 +478,8 @@ This API is used to suppress select elements of row inconsistencies
.. reserve-in-inconsistency-list:
-----------------------------------------------
-Obtaining a list of reserve in inconsistencies
-----------------------------------------------
+Reserve In Inconsistencies
+--------------------------
This API is used to obtain a list of reserve in inconsistencies
@@ -489,12 +542,6 @@ This API is used to obtain a list of reserve in inconsistencies
-.. reserve-in-inconsistency-update:
-
--------------------------------------------------
-Supressing elements of reserve in inconsistencies
--------------------------------------------------
-
This API is used to suppress select elements of reserve in inconsistencies
.. http:patch:: /reserve-in-inconsistency
@@ -503,29 +550,8 @@ This API is used to suppress select elements of reserve in inconsistencies
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -536,9 +562,8 @@ This API is used to suppress select elements of reserve in inconsistencies
.. purse-not-closed-inconsistencies-list:
-----------------------------------------------------
-Obtaining a list of purse not closed inconsistencies
-----------------------------------------------------
+Purse Not Closed Inconsistencies
+--------------------------------
This API is used to obtain a list of purse not closed inconsistencies
@@ -595,12 +620,6 @@ This API is used to obtain a list of purse not closed inconsistencies
-.. purse-not-closed-inconsistencies-update:
-
--------------------------------------------------------
-Supressing elements of purse not closed inconsistencies
--------------------------------------------------------
-
This API is used to suppress select elements of purse not closed inconsistencies
.. http:patch:: /purse-not-closed-inconsistencies
@@ -609,29 +628,8 @@ This API is used to suppress select elements of purse not closed inconsistencies
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -642,9 +640,8 @@ This API is used to suppress select elements of purse not closed inconsistencies
.. reserve-not-closed-inconsistency-list:
-------------------------------------------------------
-Obtaining a list of reserve not closed inconsistencies
-------------------------------------------------------
+Reserve Not Closed Inconsistencies
+----------------------------------
This API is used to obtain a list of reserve not closed inconsistencies
@@ -703,12 +700,6 @@ This API is used to obtain a list of reserve not closed inconsistencies
-.. reserve-not-closed-inconsistency-update:
-
----------------------------------------------------------
-Supressing elements of reserve not closed inconsistencies
----------------------------------------------------------
-
This API is used to suppress select elements of reserve not closed inconsistencies
.. http:patch:: /reserve-not-closed-inconsistency
@@ -717,29 +708,8 @@ This API is used to suppress select elements of reserve not closed inconsistenci
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -750,9 +720,8 @@ This API is used to suppress select elements of reserve not closed inconsistenci
.. reserve-balance-insufficient-inconsistency-list:
-----------------------------------------------------------------
-Obtaining a list of reserve balance insufficient inconsistencies
-----------------------------------------------------------------
+Reserve Balance Insufficient Inconsistencies
+--------------------------------------------
This API is used to obtain a list of reserve balance insufficient inconsistencies
@@ -809,12 +778,6 @@ This API is used to obtain a list of reserve balance insufficient inconsistencie
-.. reserve-balance-insufficient-inconsistency-update:
-
--------------------------------------------------------------------
-Supressing elements of reserve balance insufficient inconsistencies
--------------------------------------------------------------------
-
This API is used to suppress select elements of reserve balance insufficient inconsistencies
.. http:patch:: /reserve-balance-insufficient-inconsistency
@@ -823,29 +786,8 @@ This API is used to suppress select elements of reserve balance insufficient inc
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -856,9 +798,8 @@ This API is used to suppress select elements of reserve balance insufficient inc
.. bad-sig-losses-list:
-----------------------------------
-Obtaining a list of bad sig losses
-----------------------------------
+Bad Sig Losses
+--------------
This API is used to obtain a list of bad sig losses
@@ -917,12 +858,6 @@ This API is used to obtain a list of bad sig losses
-.. bad-sig-losses-update:
-
--------------------------------------
-Supressing elements of bad sig losses
--------------------------------------
-
This API is used to suppress select elements of bad sig losses
.. http:patch:: /bad-sig-losses
@@ -931,29 +866,8 @@ This API is used to suppress select elements of bad sig losses
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -964,9 +878,8 @@ This API is used to suppress select elements of bad sig losses
.. coin-inconsistency-list:
-----------------------------------------
-Obtaining a list of coin inconsistencies
-----------------------------------------
+Coin Inconsistencies
+--------------------
This API is used to obtain a list of coin inconsistencies
@@ -1027,12 +940,6 @@ This API is used to obtain a list of coin inconsistencies
-.. coin-inconsistency-update:
-
--------------------------------------------
-Supressing elements of coin inconsistencies
--------------------------------------------
-
This API is used to suppress select elements of coin inconsistencies
.. http:patch:: /coin-inconsistency
@@ -1041,29 +948,8 @@ This API is used to suppress select elements of coin inconsistencies
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -1074,9 +960,8 @@ This API is used to suppress select elements of coin inconsistencies
.. balances-list:
-----------------------------
-Obtaining a list of balances
-----------------------------
+Balances
+--------
This API is used to obtain a list of balances
@@ -1132,12 +1017,6 @@ This API is used to obtain a list of balances
-.. balances-update:
-
--------------------------------
-Supressing elements of balances
--------------------------------
-
This API is used to suppress select elements of balances
.. http:patch:: /balances
@@ -1146,29 +1025,8 @@ This API is used to suppress select elements of balances
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -1179,9 +1037,8 @@ This API is used to suppress select elements of balances
.. denominations-without-sigs-list:
-----------------------------------------------
-Obtaining a list of denominations without sigs
-----------------------------------------------
+Denominations Without Sigs
+--------------------------
This API is used to obtain a list of denominations without sigs
@@ -1240,12 +1097,6 @@ This API is used to obtain a list of denominations without sigs
-.. denominations-without-sigs-update:
-
--------------------------------------------------
-Supressing elements of denominations without sigs
--------------------------------------------------
-
This API is used to suppress select elements of denominations without sigs
.. http:patch:: /denominations-without-sigs
@@ -1254,29 +1105,8 @@ This API is used to suppress select elements of denominations without sigs
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -1287,9 +1117,8 @@ This API is used to suppress select elements of denominations without sigs
.. misattribution-in-inconsistency-list:
------------------------------------------------------
-Obtaining a list of misattribution in inconsistencies
------------------------------------------------------
+Misattribution In Inconsistencies
+---------------------------------
This API is used to obtain a list of misattribution in inconsistencies
@@ -1346,12 +1175,6 @@ This API is used to obtain a list of misattribution in inconsistencies
-.. misattribution-in-inconsistency-update:
-
---------------------------------------------------------
-Supressing elements of misattribution in inconsistencies
---------------------------------------------------------
-
This API is used to suppress select elements of misattribution in inconsistencies
.. http:patch:: /misattribution-in-inconsistency
@@ -1360,29 +1183,8 @@ This API is used to suppress select elements of misattribution in inconsistencie
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -1393,9 +1195,8 @@ This API is used to suppress select elements of misattribution in inconsistencie
.. progress-list:
-----------------------------
-Obtaining a list of progress
-----------------------------
+Progress
+--------
This API is used to obtain a list of progress
@@ -1448,12 +1249,6 @@ This API is used to obtain a list of progress
-.. progress-update:
-
--------------------------------
-Supressing elements of progress
--------------------------------
-
This API is used to suppress select elements of progress
.. http:patch:: /progress
@@ -1462,29 +1257,8 @@ This API is used to suppress select elements of progress
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -1495,9 +1269,8 @@ This API is used to suppress select elements of progress
.. reserves-list:
-----------------------------
-Obtaining a list of reserves
-----------------------------
+Reserves
+--------
This API is used to obtain a list of reserves
@@ -1568,12 +1341,6 @@ This API is used to obtain a list of reserves
-.. reserves-update:
-
--------------------------------
-Supressing elements of reserves
--------------------------------
-
This API is used to suppress select elements of reserves
.. http:patch:: /reserves
@@ -1582,29 +1349,8 @@ This API is used to suppress select elements of reserves
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -1615,9 +1361,8 @@ This API is used to suppress select elements of reserves
.. deposit-confirmations-list:
------------------------------------------
-Obtaining a list of deposit confirmations
------------------------------------------
+Deposit Confirmations
+---------------------
This API is used to obtain a list of deposit confirmations
@@ -1696,12 +1441,6 @@ This API is used to obtain a list of deposit confirmations
-.. deposit-confirmations-update:
-
---------------------------------------------
-Supressing elements of deposit confirmations
---------------------------------------------
-
This API is used to suppress select elements of deposit confirmations
.. http:patch:: /deposit-confirmations
@@ -1710,42 +1449,43 @@ This API is used to suppress select elements of deposit confirmations
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
+ .. note::
- :http:statuscode:`404 Not Found`:
- No elements could be found.
+ This API is still experimental. The API will be further developed as needed.
- **Details:**
- .. ts:def:: GenericUpdate
- interface GenericUpdate {
- row_id : Integer;
+This API is used by the auditor to delete an audited deposit confirmation.
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+.. http:delete:: /deposit-confirmation/$SERIAL_ID
- .. note::
+ Delete deposit confirmation entry with given serial_id.
- This API is still experimental. The API will be further developed as needed.
+ **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:
-----------------------------------------------------------------------
-Obtaining a list of denomination key validity withdraw inconsistencies
-----------------------------------------------------------------------
+Denomination Key Validity Withdraw Inconsistencies
+--------------------------------------------------
This API is used to obtain a list of denomination key validity withdraw inconsistencies
@@ -1802,12 +1542,6 @@ This API is used to obtain a list of denomination key validity withdraw inconsis
-.. denomination-key-validity-withdraw-inconsistency-update:
-
--------------------------------------------------------------------------
-Supressing elements of denomination key validity withdraw inconsistencies
--------------------------------------------------------------------------
-
This API is used to suppress select elements of denomination key validity withdraw inconsistencies
.. http:patch:: /denomination-key-validity-withdraw-inconsistency
@@ -1816,29 +1550,8 @@ This API is used to suppress select elements of denomination key validity withdr
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -1849,9 +1562,8 @@ This API is used to suppress select elements of denomination key validity withdr
.. purses-list:
---------------------------
-Obtaining a list of purses
---------------------------
+Purses
+------
This API is used to obtain a list of purses
@@ -1910,12 +1622,6 @@ This API is used to obtain a list of purses
-.. purses-update:
-
------------------------------
-Supressing elements of purses
------------------------------
-
This API is used to suppress select elements of purses
.. http:patch:: /purses
@@ -1924,29 +1630,8 @@ This API is used to suppress select elements of purses
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -1957,9 +1642,8 @@ This API is used to suppress select elements of purses
.. amount-arithmetic-inconsistency-list:
------------------------------------------------------
-Obtaining a list of amount arithmetic inconsistencies
------------------------------------------------------
+Amount Arithmetic Inconsistencies
+---------------------------------
This API is used to obtain a list of amount arithmetic inconsistencies
@@ -2018,12 +1702,6 @@ This API is used to obtain a list of amount arithmetic inconsistencies
-.. amount-arithmetic-inconsistency-update:
-
---------------------------------------------------------
-Supressing elements of amount arithmetic inconsistencies
---------------------------------------------------------
-
This API is used to suppress select elements of amount arithmetic inconsistencies
.. http:patch:: /amount-arithmetic-inconsistency
@@ -2032,29 +1710,8 @@ This API is used to suppress select elements of amount arithmetic inconsistencie
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -2065,9 +1722,8 @@ This API is used to suppress select elements of amount arithmetic inconsistencie
.. historic-denomination-revenue-list:
--------------------------------------------------
-Obtaining a list of historic denomination revenue
--------------------------------------------------
+Historic Denomination Revenue
+-----------------------------
This API is used to obtain a list of historic denomination revenue
@@ -2124,12 +1780,6 @@ This API is used to obtain a list of historic denomination revenue
-.. historic-denomination-revenue-update:
-
-----------------------------------------------------
-Supressing elements of historic denomination revenue
-----------------------------------------------------
-
This API is used to suppress select elements of historic denomination revenue
.. http:patch:: /historic-denomination-revenue
@@ -2138,29 +1788,8 @@ This API is used to suppress select elements of historic denomination revenue
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -2171,9 +1800,8 @@ This API is used to suppress select elements of historic denomination revenue
.. denomination-pending-list:
-----------------------------------------
-Obtaining a list of denomination pending
-----------------------------------------
+Denomination Pending
+--------------------
This API is used to obtain a list of denomination pending
@@ -2234,12 +1862,6 @@ This API is used to obtain a list of denomination pending
-.. denomination-pending-update:
-
--------------------------------------------
-Supressing elements of denomination pending
--------------------------------------------
-
This API is used to suppress select elements of denomination pending
.. http:patch:: /denomination-pending
@@ -2248,29 +1870,8 @@ This API is used to suppress select elements of denomination pending
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -2281,9 +1882,8 @@ This API is used to suppress select elements of denomination pending
.. historic-reserve-summary-list:
---------------------------------------------
-Obtaining a list of historic reserve summary
---------------------------------------------
+Historic Reserve Summary
+------------------------
This API is used to obtain a list of historic reserve summary
@@ -2338,12 +1938,6 @@ This API is used to obtain a list of historic reserve summary
-.. historic-reserve-summary-update:
-
------------------------------------------------
-Supressing elements of historic reserve summary
------------------------------------------------
-
This API is used to suppress select elements of historic reserve summary
.. http:patch:: /historic-reserve-summary
@@ -2352,29 +1946,8 @@ This API is used to suppress select elements of historic reserve summary
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -2385,9 +1958,8 @@ This API is used to suppress select elements of historic reserve summary
.. exchange-signkeys-list:
--------------------------------------
-Obtaining a list of exchange signkeys
--------------------------------------
+Exchange Signkeys
+-----------------
This API is used to obtain a list of exchange signkeys
@@ -2446,12 +2018,6 @@ This API is used to obtain a list of exchange signkeys
-.. exchange-signkeys-update:
-
-----------------------------------------
-Supressing elements of exchange signkeys
-----------------------------------------
-
This API is used to suppress select elements of exchange signkeys
.. http:patch:: /exchange-signkeys
@@ -2460,29 +2026,8 @@ This API is used to suppress select elements of exchange signkeys
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -2493,9 +2038,8 @@ This API is used to suppress select elements of exchange signkeys
.. wire-format-inconsistency-list:
------------------------------------------------
-Obtaining a list of wire format inconsistencies
------------------------------------------------
+Wire Format Inconsistencies
+---------------------------
This API is used to obtain a list of wire format inconsistencies
@@ -2552,12 +2096,6 @@ This API is used to obtain a list of wire format inconsistencies
-.. wire-format-inconsistency-update:
-
---------------------------------------------------
-Supressing elements of wire format inconsistencies
---------------------------------------------------
-
This API is used to suppress select elements of wire format inconsistencies
.. http:patch:: /wire-format-inconsistency
@@ -2566,29 +2104,8 @@ This API is used to suppress select elements of wire format inconsistencies
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -2599,9 +2116,8 @@ This API is used to suppress select elements of wire format inconsistencies
.. refreshes-hanging-list:
--------------------------------------
-Obtaining a list of refreshes hanging
--------------------------------------
+Refreshes Hanging
+-----------------
This API is used to obtain a list of refreshes hanging
@@ -2656,12 +2172,6 @@ This API is used to obtain a list of refreshes hanging
-.. refreshes-hanging-update:
-
-----------------------------------------
-Supressing elements of refreshes hanging
-----------------------------------------
-
This API is used to suppress select elements of refreshes hanging
.. http:patch:: /refreshes-hanging
@@ -2670,29 +2180,8 @@ This API is used to suppress select elements of refreshes hanging
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -2703,15 +2192,14 @@ This API is used to suppress select elements of refreshes hanging
.. emergency-list:
------------------------------
-Obtaining a list of emergency
------------------------------
+Emergencies
+-----------
-This API is used to obtain a list of emergency
+This API is used to obtain a list of emergencies
.. http:get:: /emergency
- Get a list of emergency stored by the auditor.
+ Get a list of emergencies stored by the auditor.
The following query parameters are optional, and can be used to customise the response:
@@ -2766,13 +2254,7 @@ This API is used to obtain a list of emergency
-.. emergency-update:
-
---------------------------------
-Supressing elements of emergency
---------------------------------
-
-This API is used to suppress select elements of emergency
+This API is used to suppress select elements of emergencies
.. http:patch:: /emergency
@@ -2780,29 +2262,8 @@ This API is used to suppress select elements of emergency
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -2813,9 +2274,8 @@ This API is used to suppress select elements of emergency
.. closure-lags-list:
---------------------------------
-Obtaining a list of closure lags
---------------------------------
+Closure Lags
+------------
This API is used to obtain a list of closure lags
@@ -2874,12 +2334,6 @@ This API is used to obtain a list of closure lags
-.. closure-lags-update:
-
------------------------------------
-Supressing elements of closure lags
------------------------------------
-
This API is used to suppress select elements of closure lags
.. http:patch:: /closure-lags
@@ -2888,29 +2342,8 @@ This API is used to suppress select elements of closure lags
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -2921,9 +2354,8 @@ This API is used to suppress select elements of closure lags
.. wire-out-inconsistency-list:
---------------------------------------------
-Obtaining a list of wire out inconsistencies
---------------------------------------------
+Wire Out Inconsistencies
+------------------------
This API is used to obtain a list of wire out inconsistencies
@@ -2980,12 +2412,6 @@ This API is used to obtain a list of wire out inconsistencies
-.. wire-out-inconsistency-update:
-
------------------------------------------------
-Supressing elements of wire out inconsistencies
------------------------------------------------
-
This API is used to suppress select elements of wire out inconsistencies
.. http:patch:: /wire-out-inconsistency
@@ -2994,29 +2420,8 @@ This API is used to suppress select elements of wire out inconsistencies
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -3027,9 +2432,8 @@ This API is used to suppress select elements of wire out inconsistencies
.. reserve-balance-summary-wrong-inconsistency-list:
------------------------------------------------------------------
-Obtaining a list of reserve balance summary wrong inconsistencies
------------------------------------------------------------------
+Reserve Balance Summary Wrong Inconsistencies
+---------------------------------------------
This API is used to obtain a list of reserve balance summary wrong inconsistencies
@@ -3086,12 +2490,6 @@ This API is used to obtain a list of reserve balance summary wrong inconsistenci
-.. reserve-balance-summary-wrong-inconsistency-update:
-
---------------------------------------------------------------------
-Supressing elements of reserve balance summary wrong inconsistencies
---------------------------------------------------------------------
-
This API is used to suppress select elements of reserve balance summary wrong inconsistencies
.. http:patch:: /reserve-balance-summary-wrong-inconsistency
@@ -3100,29 +2498,8 @@ This API is used to suppress select elements of reserve balance summary wrong in
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
@@ -3133,9 +2510,8 @@ This API is used to suppress select elements of reserve balance summary wrong in
.. row-minor-inconsistencies-list:
----------------------------------------------
-Obtaining a list of row minor inconsistencies
----------------------------------------------
+Row Minor Inconsistencies
+-------------------------
This API is used to obtain a list of row minor inconsistencies
@@ -3190,12 +2566,6 @@ This API is used to obtain a list of row minor inconsistencies
-.. row-minor-inconsistencies-update:
-
-------------------------------------------------
-Supressing elements of row minor inconsistencies
-------------------------------------------------
-
This API is used to suppress select elements of row minor inconsistencies
.. http:patch:: /row-minor-inconsistencies
@@ -3204,29 +2574,8 @@ This API is used to suppress select elements of row minor inconsistencies
**Response:**
- :http:statuscode:`204 No Content`:
- The element was updated.
-
- :http:statuscode:`403 Forbidden`:
- No or bad Bearer token provided.
-
- :http:statuscode:`404 Not Found`:
- No elements could be found.
-
- **Details:**
-
- .. ts:def:: GenericUpdate
-
- interface GenericUpdate {
-
- row_id : Integer;
-
- suppressed : boolean;
-
- // unused
- ancient : boolean;
-
- }
+ :http:statuscode:`202 Accepted`:
+ The element has been accepted for processing.
.. note::
