commit b2669742e2fd3a9224f82611f707ac8077ef9f1a
parent 41bcc2a2b2ff0d6e70a8ac72bd684e0895b3ce48
Author: Christian Grothoff <christian@grothoff.org>
Date: Sat, 14 Sep 2024 20:23:12 +0200
sanity for /progress and /balances endpoints
Diffstat:
1 file changed, 8 insertions(+), 18 deletions(-)
diff --git a/core/api-auditor.rst b/core/api-auditor.rst
@@ -936,8 +936,8 @@ could successfully dispute the resulting transactions).
: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.
:query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false.
- :query operation: A string. If specified, only returns eligible rows with this :ts:type:`BadSigLosses`.operation value. The default value is NULL which means to not filter by operaiton.
- :query use_op_spec_pub: A boolean. If true, use the value of :ts:type:`OpSpecPub` to only return eligible rows with this :ts:type:`BadSigLosses`.operation_specific_pub value. The default value is NULL.
+ :query operation: A string. If specified, only returns eligible rows with this :ts:type:`BadSigLosses`.operation value. The default value is NULL which means to not filter by operation.
+ :query op_spec_pub: An EddsaPublicKey (in base32 encoding). If given, use its value to only return rows with this :ts:type:`BadSigLosses`.operation_specific_pub value. The default value is NULL.
With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed.
@@ -1992,11 +1992,7 @@ coins in circulation, fees earned, losses experienced, etc.
**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.
- :query balance_key: a string identifying a balance. If specified, only returns elements with this exact key. The default value is NULL.
-
- With the default settings, the endpoint returns at most the 20 latest elements.
+ :query balance_key: a string identifying a balance. If specified, only returns the balance with this exact key. The default value is NULL.
**Response:**
@@ -2009,9 +2005,6 @@ coins in circulation, fees earned, losses experienced, etc.
interface Balances {
- // Unique row identifier
- row_id : Integer;
-
// String identifying a balance
balance_key : string;
@@ -2020,10 +2013,6 @@ coins in circulation, fees earned, losses experienced, etc.
}
- .. note::
-
- This endpoint is still experimental. The endpoint will be further developed as needed.
-
.. _historic-denomination-revenue-list:
@@ -2348,6 +2337,11 @@ This section contains information about the auditing progress an auditor has mad
Get the progress stored by the auditor.
+ **Request:**
+
+ :query progress_key: a string identifying a progress point. If specified, only returns the element with this exact key. The default value is NULL.
+
+
**Response:**
:http:statuscode:`200 OK`:
@@ -2367,10 +2361,6 @@ This section contains information about the auditing progress an auditor has mad
}
- .. note::
-
- This endpoint is still experimental. The endpoint will be further developed as needed.
-
----------
Complaints
----------
