From 5780e726747046892a476c7644e848b3f084c5d4 Mon Sep 17 00:00:00 2001 From: Jean-Paul Calderone <exarkun@twistedmatrix.com> Date: Mon, 11 Nov 2019 16:07:58 -0500 Subject: [PATCH] When we keep using the wrong words to describe everything, it's easy to keep using the wrong words to describe everything. --- docs/source/interface.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/source/interface.rst b/docs/source/interface.rst index 5775804..6af824a 100644 --- a/docs/source/interface.rst +++ b/docs/source/interface.rst @@ -49,19 +49,19 @@ The response is **OK** with ``application/json`` content-type response body like The elements of the list are objects like the one returned by issuing a **GET** to a child of this collection resource. -``GET /storage-plugins/privatestorageio/zkapauthz-v1/zkap`` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +``GET /storage-plugins/privatestorageio/zkapauthz-v1/blinded-token`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This endpoint allows an external agent to retrieve unused ZKAPs present in the node's ZKAP database. -ZKAPs are returned in ascending text sorted order. +This endpoint allows an external agent to retrieve unused blinded tokens present in the node's database. +Blinded tokens are returned in ascending text sorted order. This endpoint accepts several query arguments: - * limit: An integer limiting the number of ZKAPs to retrieve. - * position: A string which can be compared against ZKAP values. - Only ZKAPs which sort as great than this value are returned. + * limit: An integer limiting the number of blinded tokens to retrieve. + * position: A string which can be compared against blinded token values. + Only blinded tokens which sort as great than this value are returned. This endpoint accepts no request body. The response is **OK** with ``application/json`` content-type response body like:: - {"total": <integer>, "zkaps": [<zkap string>, ...]} + {"total": <integer>, "blinded-tokens": [<blinded token string>, ...]} -- GitLab