diff options
| author | drebs <drebs@riseup.net> | 2017-10-23 10:21:21 -0200 | 
|---|---|---|
| committer | drebs <drebs@riseup.net> | 2017-10-23 10:38:02 -0200 | 
| commit | 33e30feb2d7cedb1aecbde2f339b40f72128a585 (patch) | |
| tree | 1de5fb8dd4858dd24b1b0185c7a9aa0a954684ac /docs/reference | |
| parent | b3bf0be478060a3acdf01c924819212553775f8c (diff) | |
[doc] small fixes in documentation
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/blobs.rst | 2 | ||||
| -rw-r--r-- | docs/reference/incoming_box.rst | 30 | ||||
| -rw-r--r-- | docs/reference/server-database.rst | 22 | 
3 files changed, 26 insertions, 28 deletions
diff --git a/docs/reference/blobs.rst b/docs/reference/blobs.rst index 5d480342..17880802 100644 --- a/docs/reference/blobs.rst +++ b/docs/reference/blobs.rst @@ -39,7 +39,7 @@ The public endpoint provides the following REST API for interacting with the  =========================== ========== ================================= ============================================  path                        method     action                            accepted query string fields  =========================== ========== ================================= ============================================ -``/blobs/{uuid}             ``GET``    Get a list of blobs. filtered by  ``namespace``, ``filter_flag``, ``order_by`` +``/blobs/{uuid}``           ``GET``    Get a list of blobs. filtered by  ``namespace``, ``filter_flag``, ``order_by``                                         a flag.  ``/blobs/{uuid}/{blob_id}`` ``GET``    Get the contents of a blob.       ``namespace``  ``/blobs/{uuid}/{blob_id}`` ``PUT``    Create a blob. The content of the ``namespace`` diff --git a/docs/reference/incoming_box.rst b/docs/reference/incoming_box.rst index 04d3084c..920d03bf 100644 --- a/docs/reference/incoming_box.rst +++ b/docs/reference/incoming_box.rst @@ -230,22 +230,20 @@ registered Trusted Application Consumers.    process, attention SHOULD be payed to the callbacks not blocking the main    event loop. -Example of a Trusted Application Client Consumer: - -```python -@implementer(interfaces.IIncomingBoxConsumer) -class MyConsumer(object): -    def __init__(self): -        self.name = 'My Consumer' - -    def process(self, item, item_id, encrypted=True): -        cleartext = my_custom_decrypt(item) if encrypted else item -        processed_parts = my_custom_processing(item) -        return defer.succeed(processed_parts) - -    def save(self, parts, item_id): -        return defer.gatherResults([db.save(part) for part in parts]) -``` +Example of a Trusted Application Client Consumer:: + +    @implementer(interfaces.IIncomingBoxConsumer) +    class MyConsumer(object): +        def __init__(self): +            self.name = 'My Consumer' + +        def process(self, item, item_id, encrypted=True): +            cleartext = my_custom_decrypt(item) if encrypted else item +            processed_parts = my_custom_processing(item) +            return defer.succeed(processed_parts) + +        def save(self, parts, item_id): +            return defer.gatherResults([db.save(part) for part in parts])  Future Features diff --git a/docs/reference/server-database.rst b/docs/reference/server-database.rst index d3dfdb5f..dba9d42c 100644 --- a/docs/reference/server-database.rst +++ b/docs/reference/server-database.rst @@ -29,20 +29,20 @@ which recovery document belongs to each user.  This has some implications: -  * The security of the recovery document doc_id, and thus of access to the -    recovery document (encrypted) content, as well as tampering with the -    stored data, all rely on the difficulty of obtaining the user's password -    (supposing the user's uid is somewhat public) and the security of the hash -    function used to calculate the doc_id. +* The security of the recovery document doc_id, and thus of access to the +  recovery document (encrypted) content, as well as tampering with the +  stored data, all rely on the difficulty of obtaining the user's password +  (supposing the user's uid is somewhat public) and the security of the hash +  function used to calculate the doc_id. -  * The security of the content of a recovery document relies on the -    difficulty of obtaining the user's password. +* The security of the content of a recovery document relies on the +  difficulty of obtaining the user's password. -  * If the user looses his/her password, he/she will not be able to obtain the -    recovery document. +* If the user looses his/her password, he/she will not be able to obtain the +  recovery document. -  * Because of the above, it is recommended that recovery documents expire -    (not implemented yet) to prevent excess storage. +* Because of the above, it is recommended that recovery documents expire +  (not implemented yet) to prevent excess storage.  The authorization for creating, updating, deleting and retrieving recovery  documents on the shared database is handled by `leap.soledad.server.auth`  | 
