aljaz/python-teos
1
0
Fork 0
mirror of https://github.com/aljazceru/python-teos.git synced 2025-12-17 22:24:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fixes returns

Browse Source
This commit is contained in:
Sergi Delgado Segura
2019-12-10 12:00:40 +01:00
parent 899b60c083
commit f287bdf073
4 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
pisa/api.py
View File

@@ -26,7 +26,7 @@ def add_appointment():
encoded and contain an ``appointment`` field and optionally a ``signature`` and ``public_key`` fields.
Returns:
tuple: A tuple containing the response (``json``) and response code (``int``). For accepted appointments, the
``tuple``: A tuple containing the response (``json``) and response code (``int``). For accepted appointments, the
``rcode`` is always 0 and the response contains the signed receipt. For rejected appointments, the ``rcode`` is
a negative value and the response contains the error message. Error messages can be found at
:mod:`Errors <pisa.errors>`.
@@ -90,7 +90,7 @@ def get_appointment():
The information is requested by ``locator``.
Returns:
dict: A json formatted dictionary containing information about the requested appointment.
``dict``: A json formatted dictionary containing information about the requested appointment.
A ``status`` flag is added to the data provided by either the :mod:`Watcher <pisa.watcher>` or the
:mod:`Responder <pisa.responder>` that signals the status of the appointment.
@@ -143,7 +143,7 @@ def get_all_appointments():
This endpoint should only be accessible by the administrator. Requests are only allowed from localhost.
Returns:
dict: A json formatted dictionary containing all the appointments hold by the :mod:`Watcher <pisa.watcher>`
``dict``: A json formatted dictionary containing all the appointments hold by the :mod:`Watcher <pisa.watcher>`
(``watcher_appointments``) and by the :mod:`Responder <pisa.responder>` (``responder_jobs``).
"""
@@ -172,7 +172,7 @@ def get_block_count():
testers about the current block so they can define a dummy appointment without having to run a bitcoin node.
Returns:
dict: A json encoded dictionary containing the block height.
``dict``: A json encoded dictionary containing the block height.
"""