commit 227aa1bb0fc61cc3f79600737d11a30ea0f58431
parent a9422f567486f62c1f8709f7f04e99cac581822a
Author: Christian Grothoff <christian@grothoff.org>
Date: Fri, 26 Dec 2025 14:57:14 +0100
-minor corrections of new API
Diffstat:
1 file changed, 24 insertions(+), 9 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -3652,6 +3652,13 @@ Inspecting groups
**Required permission:** ``groups-read``
+ **Request:**
+
+ :query limit: *Optional.*
+ At most return the given number of results. Negative for descending by ``serial``, positive for ascending by ``serial``. Defaults to ``-20``.
+ :query offset: *Optional.*
+ Starting ``serial`` for :ref:`pagination <row-id-pagination>`.
+
**Response:**
:http:statuscode:`200 OK`:
@@ -5726,7 +5733,7 @@ Adding reports
report_frequency: RelativeTime;
// Report frequency shift
- report_frequency_shift: Integer;
+ report_frequency_shift: RelativeTime;
}
@@ -5771,6 +5778,13 @@ Inspecting reports
**Required permission:** ``reports-read``
+ **Request:**
+
+ :query limit: *Optional.*
+ At most return the given number of results. Negative for descending by ``serial``, positive for ascending by ``serial``. Defaults to ``-20``.
+ :query offset: *Optional.*
+ Starting ``serial`` for :ref:`pagination <row-id-pagination>`.
+
**Response:**
:http:statuscode:`200 OK`:
@@ -5855,7 +5869,7 @@ Inspecting reports
report_frequency: RelativeTime;
// Report frequency shift
- report_frequency_shift: Integer;
+ report_frequency_shift: RelativeTime;
// Numeric `error code <error-codes>` unique to the
// error encountered in generating the latest report.
@@ -6006,6 +6020,13 @@ Inspecting pots
**Required permission:** ``pots-read``
+ **Request:**
+
+ :query limit: *Optional.*
+ At most return the given number of results. Negative for descending by ``serial``, positive for ascending by ``serial``. Defaults to ``-20``.
+ :query offset: *Optional.*
+ Starting ``serial`` for :ref:`pagination <row-id-pagination>`.
+
**Response:**
:http:statuscode:`200 OK`:
@@ -6047,7 +6068,7 @@ Inspecting pots
.. http:get:: [/instances/$INSTANCES]/private/pots/$POT_SERIAL
- This is used to obtain detailed information about apecific pot.
+ This is used to obtain detailed information about specific pot.
**Required permission:** ``pots-read``
@@ -6065,9 +6086,6 @@ Inspecting pots
interface PotDetailResponse {
- // Pot identifier
- pot_serial: Integer;
-
// Description of the pot. Possibly included
// in the pot message.
description: string;
@@ -6100,9 +6118,6 @@ Removing pots
-
-
-
----------------------------------------
Token Families: Subscriptions, Discounts
----------------------------------------
