From bf2f07006688ce5a06a6b4f3da76e7c96eed9f3a Mon Sep 17 00:00:00 2001 From: Jean-Paul Calderone <exarkun@twistedmatrix.com> Date: Fri, 23 Jul 2021 13:29:44 -0400 Subject: [PATCH] improve docs around the unblinded-tokens GET interface --- docs/source/interface.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/source/interface.rst b/docs/source/interface.rst index 5911d12..81435b1 100644 --- a/docs/source/interface.rst +++ b/docs/source/interface.rst @@ -147,7 +147,7 @@ This endpoint accepts several query arguments: * limit: An integer limiting the number of unblinded tokens to retrieve. * position: A string which can be compared against unblinded token values. - Only unblinded tokens which sort as great than this value are returned. + Only unblinded tokens which follow this token in the stable order are returned. This endpoint accepts no request body. @@ -158,6 +158,10 @@ The response is **OK** with ``application/json`` content-type response body like , "lease-maintenance-spending": <spending object> } +The value associated with ``total`` gives the total number of unblinded tokens in the node's database +(independent of any limit placed on this query). +The value associated with ``unblinded-tokens`` gives the requested list of unblinded tokens. + The ``<spending object>`` may be ``null`` if the lease maintenance process has never run. If it has run, ``<spending object>`` has two properties: -- GitLab