From f4fd1529ca35c75b070849f29d38e05f0d8e01bb Mon Sep 17 00:00:00 2001
From: Jean-Paul Calderone <exarkun@twistedmatrix.com>
Date: Tue, 25 Feb 2020 14:16:24 -0500
Subject: [PATCH] Document the changes to the interface
---
docs/source/interface.rst | 12 +++++++++++-
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/docs/source/interface.rst b/docs/source/interface.rst
index e790bd8..2c5e990 100644
--- a/docs/source/interface.rst
+++ b/docs/source/interface.rst
@@ -117,4 +117,14 @@ This endpoint accepts no request body.
The response is **OK** with ``application/json`` content-type response body like::
- {"total": <integer>, "unblinded-tokens": [<unblinded token string>, ...]}
+ { "total": <integer>
+ , "unblinded-tokens": [<unblinded token string>, ...]
+ , "lease-maintenance-spending": <spending object>
+ }
+
+The ``<spending object>`` may be ``null`` if the lease maintenance process has never run.
+If it has run,
+``<spending object>`` has two properties:
+
+ * ``when``: associated with an ISO8601 datetime string giving the approximate time the process ran
+ * ``count``: associated with a number giving the number of passes which would need to be spent to renew leases on all stored objects seen during the lease maintenance activity
--
GitLab