Skip to content

Commit

Permalink
more update for the interface CEGA/LEGA
Browse files Browse the repository at this point in the history
  • Loading branch information
silverdaz committed Oct 24, 2018
1 parent 372800a commit 69adcb4
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions docs/connection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,13 +124,13 @@ LocalEGAs can use what message format they see fit.
The message arriving in the ``v1.files`` queue contains the following fields

* ``user``
* ``filepath``
* ``file_path``

The message arriving in ``v1.files.completed`` (from LocalEGA instances) must contain:

* ``user``
* ``filepath``
* ``checksums``, as an array of JSON object with:
* ``file_path``
* ``decrypted_checksums``, as an array of JSON object with:

- ``type`` (md5 or sha256)
- ``value``
Expand All @@ -140,15 +140,21 @@ The md5 should be present since it is used to compute the stable ID.
The message arriving in ``v1.stableIDs`` contains:

* ``user``
* ``filePath``
* ``stableId``
* ``checksum``:
* ``file_path``
* ``stable_id``
* ``decrypted_checksums``, as an array of JSON object with:

- ``type`` (sha256 only)
- ``type``
- ``value``

.. note:: This allows not to leak out any internal file ID.

An error message arriving in the ``v1.files.errors`` queue contains the following fields:

* ``user``
* ``file_path``
* ``reason``

Examples
--------

Expand Down

0 comments on commit 69adcb4

Please sign in to comment.