Skip to content

Commit

Permalink
update docs to show created uuid for replies
Browse files Browse the repository at this point in the history
  • Loading branch information
heartsucker committed Nov 2, 2018
1 parent 717a442 commit 30a00d0
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/development/journalist_api.rst
Expand Up @@ -363,25 +363,29 @@ source.
with the reply in the request body:

.. code:: sh
.. code:: json
{
"reply": "-----BEGIN PGP MESSAGE-----[...]-----END PGP MESSAGE-----"
}
Response 201 created (application/json):

.. code:: sh
.. code:: json
{
"message": "Your reply has been stored"
"message": "Your reply has been stored",
"uuid": "0bc588dd-f613-4999-b21e-1cebbd9adc2c"
}
The returned ``uuid`` field is the UUID of the reply and can be used to
reference this reply later.

Replies that do not contain a GPG encrypted message will be rejected:

Response 400 (application/json):

.. code:: sh
.. code:: json
{
"message": "You must encrypt replies client side"
Expand Down

0 comments on commit 30a00d0

Please sign in to comment.