Problem: Docs for BEP#3 implementation not updated (#2123)

* Problem: Docs for BEP#3 implementation not updated

Solutions: Update docs for #2070 and #2106

* Problem: 'Validator update' docs language not clear

Solution: Re-write the documentation which explains when validators are updated

* Problem: Typos and BEP reference missing

Solution: Fix typos and add BEP reference
This commit is contained in:
Vanshdeep Singh
2018-03-21 13:53:08 +05:30
committed by vrde
parent 59abb358f8
commit ef26220c7f
2 changed files with 66 additions and 0 deletions

View File

@@ -515,6 +515,50 @@ Transaction Metadata
text search.
Validators
--------------------
.. http:get:: /api/v1/validators
Return the local validators set of a given node.
**Example request**:
.. sourcecode:: http
GET /api/v1/validators HTTP/1.1
Host: example.com
**Example response**:
.. sourcecode:: http
HTTP/1.1 200 OK
Content-type: application/json
[
{
"pub_key": {
"data":"4E2685D9016126864733225BE00F005515200727FBAB1312FC78C8B76831255A",
"type":"ed25519"
},
"power": 10
},
{
"pub_key": {
"data":"608D839D7100466D6BA6BE79C320F8B81DE93CFAA58CF9768CF921C6371F2553",
"type":"ed25519"
},
"power": 5
}
]
:resheader Content-Type: ``application/json``
:statuscode 200: The query was executed successfully and validators set was returned.
Advanced Usage
--------------------------------