diff --git a/docs/source/interface.rst b/docs/source/interface.rst index 57758049181638e41ee3ed8156f8fb758671a827..6af824a43fdf53c1eabd40e2190d21923ceefb77 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>, ...]}