Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Edits to the common/schema/README.md file

Browse Source
This commit is contained in:
Troy McConaghy 2018-02-16 15:48:12 +01:00
parent 96f30da875
commit 7a292ba6ec
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
bigchaindb/common/schema/README.md
View File

@ -4,22 +4,24 @@ This directory contains the schemas for the different JSON documents BigchainDB
The aim is to provide: The aim is to provide:
- a strict definition of the data structures used in BigchainDB - a strict definition of the data structures used in BigchainDB,
- a language independent tool to validate the structure of incoming/outcoming - a language-independent tool to validate the structure of incoming/outcoming
data (there are several ready to use data. (There are several ready to use
[implementations](http://json-schema.org/implementations.html) written in [implementations](http://json-schema.org/implementations.html) written in
different languages) different languages.)
## Sources ## Sources
The file defining the JSON Schema for votes (`vote.yaml`) is BigchainDB-specific.
The files defining the JSON Schema for transactions (`transaction_*.yaml`) The files defining the JSON Schema for transactions (`transaction_*.yaml`)
are copied from the [IPDB Protocol](https://github.com/ipdb/ipdb-protocol). are based on the [IPDB Transaction Spec](https://github.com/ipdb/ipdb-tx-spec).
If you want to add a new version, you must add it to the IPDB Protocol first. If you want to add a new transaction version,
(You can't change existing versions. Those were used to validate old transactions you must add it to the IPDB Transaction Spec first.
(You can't change the JSON Schema files for old versions.
Those were used to validate old transactions
and are needed to re-check those transactions.) and are needed to re-check those transactions.)
The file defining the JSON Schema for votes (`vote.yaml`) is BigchainDB-specific.
## Learn about JSON Schema ## Learn about JSON Schema
A good resource is [Understanding JSON Schema](http://spacetelescope.github.io/understanding-json-schema/index.html). A good resource is [Understanding JSON Schema](http://spacetelescope.github.io/understanding-json-schema/index.html).