From 7cb6c8913b94fe2ef57a6f466d2ddbcd2846432c Mon Sep 17 00:00:00 2001 From: Scott Sadler Date: Thu, 1 Dec 2016 15:55:24 +0100 Subject: [PATCH] unversion vote.rst since it's JITted now --- docs/server/source/schema/vote.rst | 131 ----------------------------- 1 file changed, 131 deletions(-) delete mode 100644 docs/server/source/schema/vote.rst diff --git a/docs/server/source/schema/vote.rst b/docs/server/source/schema/vote.rst deleted file mode 100644 index 292cec5c..00000000 --- a/docs/server/source/schema/vote.rst +++ /dev/null @@ -1,131 +0,0 @@ -.. This file was auto generated by generate_schema_documentation.py - -=========== -Vote Schema -=========== - -Vote ----- - -A Vote is an endorsement of a Block (identified by a hash) by -a node (identified by a public key). - -The outer Vote object contains the details of the vote being made -as well as the signature and identifying information of the node -passing the vote. - - -Vote.node_pubkey -^^^^^^^^^^^^^^^^ - -**type:** string - -Ed25519 public key identifying the voting node. - - - -Vote.signature -^^^^^^^^^^^^^^ - -**type:** string - -Ed25519 signature of the `Vote Details`_ object. - - -Vote.vote -^^^^^^^^^ - -**type:** object - -`Vote Details`_ to be signed. - - - - - -Vote Details ------------- - -`Vote Details`_ to be signed. - - -Vote.previous_block -^^^^^^^^^^^^^^^^^^^ - -**type:** string - -ID (SHA3 hash) of the block that precedes the block being voted on. -The notion of a "previous" block is subject to vote. - - - -Vote.voting_for_block -^^^^^^^^^^^^^^^^^^^^^ - -**type:** string - -ID (SHA3 hash) of the block being voted on. - - - -Vote.is_block_valid -^^^^^^^^^^^^^^^^^^^ - -**type:** boolean - -This field is ``true`` if the block was deemed valid by the node. - - - -Vote.invalid_reason -^^^^^^^^^^^^^^^^^^^ - -**type:** string or null - -Reason the block is voted invalid, or ``null``. - -.. container:: notice - - **Note**: The invalid_reason was not being used and may be dropped in a future version of BigchainDB. See Issue `#217 `_ on GitHub. - - - -Vote.timestamp -^^^^^^^^^^^^^^ - -**type:** string - -Unix timestamp that the vote was created by the node, according -to the system time of the node. - - - - - - -.. raw:: html - -