From 374b6301c61b8bb7acdce75536e7afefb16b8bc2 Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Thu, 23 Nov 2017 16:21:19 +0100 Subject: [PATCH] In readme file about JSON Schema files, note provenance and update process --- bigchaindb/common/schema/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/bigchaindb/common/schema/README.md b/bigchaindb/common/schema/README.md index 4b2cf873..76ff7f28 100644 --- a/bigchaindb/common/schema/README.md +++ b/bigchaindb/common/schema/README.md @@ -10,6 +10,16 @@ The aim is to provide: [implementations](http://json-schema.org/implementations.html) written in different languages) +## Sources + +The file defining the JSON Schema for votes (`vote.yaml`) is BigchainDB-specific. + +The files defining the JSON Schema for transactions (`transaction_*.yaml`) +are copied from the [IPDB Protocol](https://github.com/ipdb/ipdb-protocol). +If you want to add a new version, you must add it to the IPDB Protocol first. +(You can't change existing versions. Those were used to validate old transactions +and are needed to re-check those transactions.) + ## Learn about JSON Schema A good resource is [Understanding JSON Schema](http://spacetelescope.github.io/understanding-json-schema/index.html).