taler-docs

commit 2fa9a315c3d8da301fe7260b58abb9b049a6778b
parent f8cc2452cf4e81d239c5ffa077a7280cf960ed91
Author: Martin Schanzenbach <schanzen@gnunet.org>
Date:   Mon, 31 Mar 2025 16:35:26 +0200

Add description to statistic details

Diffstat:
M
core/api-merchant.rst
 | 
20
++++++++++++++++----

1 file changed, 16 insertions(+), 4 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -1415,7 +1415,7 @@ Getting statistics
 
   **Request:**
 
-  :query by: *Optional*. If set to "BUCKET", only statistics by bucket will be returned. If set to "INTERVAL", only staistics kept by interval will be returned. If not set or set to "ANY", both will be returned.
+  :query by: *Optional*. If set to "BUCKET", only statistics by bucket will be returned. If set to "INTERVAL", only statistics kept by interval will be returned. If not set or set to "ANY", both will be returned.
              
   **Response:**
 
@@ -1444,6 +1444,9 @@ Getting statistics
 
     interface MerchantStatisticAmountByBucket {
 
+       // Human-readable statistic description.
+       description: string;
+
        // Start time of the bucket (inclusive)
        start_time: Timestamp;
 
@@ -1459,9 +1462,12 @@ Getting statistics
 
     }
 
-    .. ts:def:: MerchantStatisticAmountByInterval
+  .. ts:def:: MerchantStatisticAmountByInterval
+
+    interface MerchantStatisticAmountByInterval {
 
-      interface MerchantStatisticAmountByInterval {
+       // Human-readable statistic description.
+       description: string;
 
        // Start time of the interval.
        // The interval always ends at the response
@@ -1484,7 +1490,7 @@ Getting statistics
 
   **Request:**
 
-  :query by: *Optional*. If set to "BUCKET", only statistics by bucket will be returned. If set to "INTERVAL", only staistics kept by interval will be returned. If not set or set to "ANY", both will be returned.
+    :query by: *Optional*. If set to "BUCKET", only statistics by bucket will be returned. If set to "INTERVAL", only statistics kept by interval will be returned. If not set or set to "ANY", both will be returned.
 
   **Response:**
 
@@ -1513,6 +1519,9 @@ Getting statistics
 
     interface MerchantStatisticCounterByBucket {
 
+      // Human-readable statistic description.
+      description: string;
+
       // Start time of the bucket (inclusive)
       start_time: Timestamp;
 
@@ -1532,6 +1541,9 @@ Getting statistics
 
     interface MerchantStatisticCounterByInterval {
 
+      // Human-readable statistic description.
+      description: string;
+
       // Start time of the interval.
       // The interval always ends at the response
       // generation time.