Merge pull request #1878 from bigchaindb/issue/1873/version-the-tx-schema-files

Version the transaction schema files

bigchaindb/common/schema/__init__.py

@@ -22,9 +22,14 @@ def _load_schema(name):
     return path, (schema, fast_schema)
 
 
-TX_SCHEMA_PATH, TX_SCHEMA_COMMON = _load_schema('transaction')
-_, TX_SCHEMA_CREATE = _load_schema('transaction_create')
-_, TX_SCHEMA_TRANSFER = _load_schema('transaction_transfer')
+TX_SCHEMA_VERSION = 'v1.0'
+
+TX_SCHEMA_PATH, TX_SCHEMA_COMMON = _load_schema('transaction_' +
+                                                TX_SCHEMA_VERSION)
+_, TX_SCHEMA_CREATE = _load_schema('transaction_create_' +
+                                   TX_SCHEMA_VERSION)
+_, TX_SCHEMA_TRANSFER = _load_schema('transaction_transfer_' +
+                                     TX_SCHEMA_VERSION)
 VOTE_SCHEMA_PATH, VOTE_SCHEMA = _load_schema('vote')
 
 

bigchaindb/common/schema/transaction_v1.0.yaml

@@ -1,6 +1,5 @@
 ---
 "$schema": "http://json-schema.org/draft-04/schema#"
-id: "http://www.bigchaindb.com/schema/transaction.json"
 type: object
 additionalProperties: false
 title: Transaction Schema

docs/server/source/appendices/tx-yaml-files.rst

@@ -2,11 +2,8 @@ The Transaction Schema Files
 ============================
 
 BigchainDB checks all :ref:`transactions <The Transaction Model>`
-(JSON documents) against a formal schema
-defined in some JSON Schema files named
-transaction.yaml,
-transaction_create.yaml and
-transaction_transfer.yaml.
+against a formal schema
+defined in some JSON Schema files.
 The contents of those files are copied below.
 To understand those contents
 (i.e. JSON Schema), check out
@@ -16,22 +13,22 @@ by Michael Droettboom or
 `json-schema.org <http://json-schema.org/>`_.
 
 
-transaction.yaml
-----------------
+transaction_v1.0.yaml
+---------------------
 
-.. literalinclude:: ../../../../bigchaindb/common/schema/transaction.yaml
+.. literalinclude:: ../../../../bigchaindb/common/schema/transaction_v1.0.yaml
    :language: yaml
 
 
-transaction_create.yaml
------------------------
+transaction_create_v1.0.yaml
+----------------------------
 
-.. literalinclude:: ../../../../bigchaindb/common/schema/transaction_create.yaml
+.. literalinclude:: ../../../../bigchaindb/common/schema/transaction_create_v1.0.yaml
    :language: yaml
 
 
-transaction_transfer.yaml
--------------------------
+transaction_transfer_v1.0.yaml
+------------------------------
 
-.. literalinclude:: ../../../../bigchaindb/common/schema/transaction_transfer.yaml
+.. literalinclude:: ../../../../bigchaindb/common/schema/transaction_transfer_v1.0.yaml
    :language: yaml

docs/server/source/data-models/transaction-model.rst

@@ -68,7 +68,6 @@ The Transaction Schema
 ----------------------
 
 BigchainDB checks all transactions (JSON documents)
-against a formal schema defined in :ref:`some JSON Schema files named
-transaction.yaml,
-transaction_create.yaml and
-transaction_transfer.yaml <The Transaction Schema Files>`.
+against a formal schema defined in :ref:`some JSON Schema files
+(copied verbatim into the Appendices) 
+<The Transaction Schema Files>`.