Skip to content

Commit

Permalink
added bandwidth to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
F483 committed Mar 15, 2016
1 parent f18c1a8 commit 64ff45f
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions README.rst
Expand Up @@ -78,7 +78,7 @@ Examples:
GET /api/register/e61ea5a799707fb9133cc2978f4c9f37da73db88/1Mym8X3heKx1sZTDyM9z9djcRCq2g715BL
RESPONSE:
Status Code: 200
Text: Json encoded node information
Text: {"bandwidth_download": 0, "payout_addr": "1Mym8X3heKx1sZTDyM9z9djcRCq2g715BL", "bandwidth_upload": 0, "last_seen": 0, "height": 0, "uptime": 100.0, "nodeid": "e61ea5a799707fb9133cc2978f4c9f37da73db88", "reg_time": 1458079196, "ip": ""}

+-------------+-------------------------------------+
| Error Codes | What happened |
Expand Down Expand Up @@ -120,7 +120,6 @@ Example:
| 404 | Farmer not found |
+-------------+----------------------------+


Online Status - JSON
********************

Expand Down Expand Up @@ -225,6 +224,36 @@ Example:
+-------------+----------------------------+


Advertise bandwidth
*******************

Allows the user to let the node know how much upload and download bandwidth they have avaivable.

::

GET /api/bandwidth/<nodeid>/<upload>/<download>


Example:

::
GET /api/bandwidth/e61ea5a799707fb9133cc2978f4c9f37da73db88/123/456
RESPONSE:
Status Code: 200
Text: Bandwidth accepted.


+-------------+----------------------------+
| Error Codes | What happened |
+=============+============================+
| 400 | Invalid nodeid |
+-------------+----------------------------+
| 401 | Bad authentication headers |
+-------------+----------------------------+
| 404 | Farmer not found |
+-------------+----------------------------+


Block Audit
***********

Expand Down

0 comments on commit 64ff45f

Please sign in to comment.