diff --git a/docs/server/source/data-models/index.rst b/docs/server/source/data-models/index.rst index 6fefe9d4..70a4fae4 100644 --- a/docs/server/source/data-models/index.rst +++ b/docs/server/source/data-models/index.rst @@ -16,4 +16,4 @@ This section unpacks each one in turn. asset-model crypto-conditions block-model - ../schema/vote + vote-model diff --git a/docs/server/source/data-models/vote-model.md b/docs/server/source/data-models/vote-model.md new file mode 100644 index 00000000..25d5029c --- /dev/null +++ b/docs/server/source/data-models/vote-model.md @@ -0,0 +1,20 @@ +# The Vote Model + +A vote has the following structure: + +```json +{ + "id": "", + "node_pubkey": "", + "vote": { + "voting_for_block": "", + "previous_block": "", + "is_block_valid": "", + "invalid_reason": "" + }, + "signature": "" +} +``` + +Note: The `invalid_reason` was not being used and may be dropped in a future version of BigchainDB. See [Issue #217](https://github.com/bigchaindb/bigchaindb/issues/217) on GitHub.