Add doc info for derive_policy_pubkey endpoint

Also updates docs for the fix in #762
pull/760/head
tuxxy 2019-02-13 23:30:41 -07:00 committed by jMyles
parent 26b1951488
commit 554a2c10fe
1 changed files with 15 additions and 1 deletions

View File

@ -104,6 +104,17 @@ Character Control Endpoints
Alice
-----
derive_policy_pubkey
~~~~~~~~~~~~~~~~~~~~
This endpoint controls the ``Alice.get_policy_pubkey_from_label`` method.
- URL: ``/derive_policy_pubkey``
- HTTP Method: ``PUT``
- Required arguments:
- ``label`` -- encoded as base64
- Returns: a hex-encoded ``policy_encrypting_pubkey``
grant
~~~~~
@ -117,7 +128,10 @@ This endpoint controls the ``Alice.grant`` method.
- ``m`` -- an integer
- ``n`` -- an integer
- ``expiration_time`` -- an ISO-8601 formatted datetime string
- Returns: a base64-encoded ``treasure_map``
- Returns:
- ``treasure_map`` -- encoded as base64
- ``policy_encrypting_pubkey`` -- encoded as hex
- ``alice_signing_pubkey`` -- encoded as hex
For more details on these arguments, see the nucypher documentation on the ``Alice.grant`` Python API method.