Nucypher
/
nucypher
mirror of https://github.com/nucypher/nucypher.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #992 from jMyles/master 

Docs bug discovered at EthNewYork.
pull/1010/head
K Prasch 2019-05-22 09:18:03 -07:00 committed by GitHub
parent c86d0f38cc bbcff592ba
commit f558e2f6af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/source/guides/character_control_guide.rst
View File

@ -64,7 +64,7 @@ The character control API uses JSON for all its endpoints. A request may look li
'label': 'dGVzdA==', 'label': 'dGVzdA==',
'm': 2, 'm': 2,
'n': 3, 'n': 3,
'expiration_time': '2019-02-14T22:23:10.771093Z', 'expiration': '2019-02-14T22:23:10.771093Z',
} }
Take a look at ``bob_encrypting_key``. Take note that it's a hex-encoded string. Take a look at ``bob_encrypting_key``. Take note that it's a hex-encoded string.
@ -75,7 +75,7 @@ Whenever the Python API expects the ``bytes`` type, the character control API wi
Integers, in our case ``m`` and ``n`` can be passed as is without encoding. Integers, in our case ``m`` and ``n`` can be passed as is without encoding.
A datetime, like ``expiration_time``, must be passed in as an ISO-8601 formatted datetime string. A datetime, like ``expiration``, must be passed in as an ISO-8601 formatted datetime string.
If you are missing a required argument in your request, you will be returned a 400 status code. If you are missing a required argument in your request, you will be returned a 400 status code.
@ -104,16 +104,14 @@ Character Control Endpoints
Alice Alice
----- -----
derive_policy_pubkey derive_policy_encrypting_key
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
This endpoint controls the ``Alice.get_policy_pubkey_from_label`` method. This endpoint controls the ``Alice.get_policy_pubkey_from_label`` method.
- URL: ``/derive_policy_pubkey`` - URL: ``/derive_policy_encrypting_key/<\label\>``
- HTTP Method: ``PUT`` - HTTP Method: ``POST``
- Required arguments: - Returns: a hex-encoded ``policy_encrypting_key``
- ``label`` -- encoded as base64
- Returns: a hex-encoded ``policy_encrypting_pubkey``
grant grant
~~~~~ ~~~~~
@ -127,7 +125,7 @@ This endpoint controls the ``Alice.grant`` method.
- ``label`` -- encoded as base64 - ``label`` -- encoded as base64
- ``m`` -- an integer - ``m`` -- an integer
- ``n`` -- an integer - ``n`` -- an integer
- ``expiration_time`` -- an ISO-8601 formatted datetime string - ``expiration`` -- an ISO-8601 formatted datetime string
- Returns: - Returns:
- ``treasure_map`` -- encoded as base64 - ``treasure_map`` -- encoded as base64
- ``policy_encrypting_pubkey`` -- encoded as hex - ``policy_encrypting_pubkey`` -- encoded as hex