commit 2e36a5e88146eb6e414872ade005d59b9c934ae8
parent 4a88e8284745fb19b1065beee932c7e340d56e0b
Author: Christian Grothoff <christian@grothoff.org>
Date: Thu, 3 Jul 2025 17:07:09 +0200
always reference non-deprecated query parameters in error messages (#7949)
Diffstat:
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -3159,10 +3159,10 @@ Inspecting orders
:query wired: *Optional*. If set to yes, only return wired orders, if no only orders with missing wire transfers. Do not give (or use "all") to see all orders regardless of wire transfer status.
:query delta: *Optional*. takes value of the form ``N (-N)``, so that at most ``N`` values strictly older (younger) than ``start`` and ``date_s`` are returned. Defaults to ``-20`` to return the last 20 entries (before ``start`` and/or ``date_s``). Deprecated in protocol **v12**. Use *limit* instead.
:query limit: *Optional*. At most return the given number of results. Negative for descending by row ID, positive for ascending by row ID. Default is ``20``. Since protocol **v12**.
- :query date_s: *Optional.* Non-negative date in seconds after the UNIX Epoc, see ``delta`` for its interpretation. If not specified, we default to the oldest or most recent entry, depending on ``delta``.
- :query start: *Optional*. Row number threshold, see ``delta`` for its interpretation. Defaults to ``INT64_MAX``, namely the biggest row id possible in the database. Deprecated in protocol **v12**. Use *offset* instead.
+ :query date_s: *Optional.* Non-negative date in seconds after the UNIX Epoc, see ``delta`` for its interpretation. If not specified, we default to the oldest or most recent entry, depending on ``limit``.
+ :query start: *Optional*. Row number threshold, see ``limit`` for its interpretation. Defaults to ``INT64_MAX``, namely the biggest row id possible in the database. Deprecated in protocol **v12**. Use *offset* instead.
:query offset: *Optional*. Starting ``row_id`` for an iteration. Since protocol **v12**.
- :query timeout_ms: *Optional*. Timeout in milliseconds to wait for additional orders if the answer would otherwise be negative (long polling). Only useful if delta is positive. Note that the merchant MAY still return a response that contains fewer than ``delta`` orders.
+ :query timeout_ms: *Optional*. Timeout in milliseconds to wait for additional orders if the answer would otherwise be negative (long polling). Only useful if ``limit`` is positive. Note that the merchant MAY still return a response that contains fewer than ``limit`` orders.
:query session_id: *Optional*. Since protocol **v6**. Filters by session ID.
:query fulfillment_url: *Optional*. Since protocol **v6**. Filters by fulfillment URL.
@@ -3177,7 +3177,7 @@ Inspecting orders
interface OrderHistory {
// Timestamp-sorted array of all orders matching the query.
- // The order of the sorting depends on the sign of ``delta``.
+ // The order of the sorting depends on the sign of ``limit``.
orders : OrderHistoryEntry[];
}