taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit d0668918c91a904a274bd051b8838481e1aad025
parent c79c79474cdd4a0ca7a7fc1fc4e6b0d10f691156
Author: Christian Grothoff <christian@grothoff.org>
Date:   Sat,  8 Aug 2026 22:04:22 +0200

remove unimplemented/dead endpoint from auditor spec

Diffstat:
Mcore/api-auditor.rst | 12------------
Dcore/auditor/get-monitoring-denomination-pending.rst | 67-------------------------------------------------------------------
2 files changed, 0 insertions(+), 79 deletions(-)

diff --git a/core/api-auditor.rst b/core/api-auditor.rst @@ -653,18 +653,6 @@ all values are final. .. include:: auditor/get-monitoring-historic-denomination-revenue.rst -.. _denomination-pending-list: - -Denomination Pending --------------------- - -This endpoint is used to obtain a list of balances for denominations that are still -active, that is coins may still be deposited (or possibly even withdrawn) and thus -the amounts given are not final. - -.. include:: auditor/get-monitoring-denomination-pending.rst - - .. _historic-reserve-summary-list: Historic Reserve Summary diff --git a/core/auditor/get-monitoring-denomination-pending.rst b/core/auditor/get-monitoring-denomination-pending.rst @@ -1,67 +0,0 @@ -.. http:get:: /monitoring/denomination-pending - - Get a list of denomination pending stored by the auditor. - - The following query parameters are optional, and can be used to customise the response: - - **Request:** - - :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. - :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. - - With the default settings, the endpoint returns at most the 20 latest elements. - - **Response:** - - :http:statuscode:`200 OK`: - The auditor responds with a top level array of :ts:type:`DenominationPending` objects. If no elements could be found, an empty array is returned - :http:statuscode:`400 Bad request`: - The request is malformed. Returned with an - ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code. - :http:statuscode:`401 Unauthorized`: - The request lacks valid authentication credentials. - The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``. - :http:statuscode:`500 Internal Server Error`: - The server experienced an internal error. - The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED`` or - ``TALER_EC_GENERIC_DB_FETCH_FAILED`` error code. - - **Details:** - - .. ts:def:: DenominationPending - - interface DenominationPending { - - // Unique row identifier - row_id : Integer; - - // Hash of the denomination public key - denom_pub_hash : HashCode; - - // Total value of coins remaining in circulation (excluding - // the value of coins that were recouped, those are always - // just under recoup_loss). - denom_balance : Amount; - - // Total value of coins redeemed that exceeds the amount we - // put into circulation. Basically, this value grows if we - // wanted to reduce denom_balance (because a coin was deposited) - // but we could not because the denom_balance was already zero. - denom_loss : Amount; - - // Total number of coins of this denomination that were - // put into circulation. - num_issued : Integer; - - // Total value of the coins put into circulation. - denom_risk : Amount; - - // Losses the exchange had from this denomination due to coins - // that were recouped (after the denomination was revoked). - recoup_loss : Amount; - - } - - .. note:: - - This endpoint is still experimental. The endpoint will be further developed as needed.