diff --git a/docs/server/source/appendices/index.rst b/docs/server/source/appendices/index.rst index 6f560458..ae2052f0 100755 --- a/docs/server/source/appendices/index.rst +++ b/docs/server/source/appendices/index.rst @@ -28,5 +28,4 @@ Appendices install-with-lxd run-with-vagrant run-with-ansible - tx-yaml-files vote-yaml diff --git a/docs/server/source/appendices/tx-yaml-files.rst b/docs/server/source/appendices/tx-yaml-files.rst deleted file mode 100644 index 64ac751c..00000000 --- a/docs/server/source/appendices/tx-yaml-files.rst +++ /dev/null @@ -1,34 +0,0 @@ -The Transaction Schema Files -============================ - -BigchainDB checks all :ref:`transactions ` -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 -`"Understanding JSON Schema" -`_ -by Michael Droettboom or -`json-schema.org `_. - - -transaction_v1.0.yaml ---------------------- - -.. literalinclude:: ../../../../bigchaindb/common/schema/transaction_v1.0.yaml - :language: yaml - - -transaction_create_v1.0.yaml ----------------------------- - -.. literalinclude:: ../../../../bigchaindb/common/schema/transaction_create_v1.0.yaml - :language: yaml - - -transaction_transfer_v1.0.yaml ------------------------------- - -.. literalinclude:: ../../../../bigchaindb/common/schema/transaction_transfer_v1.0.yaml - :language: yaml diff --git a/docs/server/source/data-models/transaction-model.rst b/docs/server/source/data-models/transaction-model.rst index 59f0357f..9a23b754 100644 --- a/docs/server/source/data-models/transaction-model.rst +++ b/docs/server/source/data-models/transaction-model.rst @@ -69,6 +69,14 @@ The Transaction Schema ---------------------- BigchainDB checks all transactions (JSON documents) -against a formal schema defined in :ref:`some JSON Schema files -(copied verbatim into the Appendices) -`. +against a formal schema defined +in some `JSON Schema `_ files. +Those files are part of the IPDB Protocol. +Their official source is the ``tx_schema/`` directory +in the `ipdb/ipdb-protocol repository on GitHub +`_, +but BigchainDB Server uses copies of those files; +those copies can be found +in the ``bigchaindb/common/schema/`` directory +in the `bigchaindb/bigchaindb repository on GitHub +`_.