mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
Added page about the transaction schema files
This commit is contained in:
parent
b3ccb09e01
commit
c6c89bfcba
@ -29,4 +29,5 @@ Appendices
|
||||
install-with-lxd
|
||||
run-with-vagrant
|
||||
run-with-ansible
|
||||
tx-yaml-files
|
||||
vote-yaml
|
||||
|
37
docs/server/source/appendices/tx-yaml-files.rst
Normal file
37
docs/server/source/appendices/tx-yaml-files.rst
Normal file
@ -0,0 +1,37 @@
|
||||
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.
|
||||
The contents of those files are copied below.
|
||||
To understand those contents
|
||||
(i.e. JSON Schema), check out
|
||||
`"Understanding JSON Schema"
|
||||
<https://spacetelescope.github.io/understanding-json-schema/index.html>`_
|
||||
by Michael Droettboom or
|
||||
`json-schema.org <http://json-schema.org/>`_.
|
||||
|
||||
|
||||
transaction.yaml
|
||||
----------------
|
||||
|
||||
.. literalinclude:: ../../../../bigchaindb/common/schema/transaction.yaml
|
||||
:language: yaml
|
||||
|
||||
|
||||
transaction_create.yaml
|
||||
-----------------------
|
||||
|
||||
.. literalinclude:: ../../../../bigchaindb/common/schema/transaction_create.yaml
|
||||
:language: yaml
|
||||
|
||||
|
||||
transaction_transfer.yaml
|
||||
-------------------------
|
||||
|
||||
.. literalinclude:: ../../../../bigchaindb/common/schema/transaction_transfer.yaml
|
||||
:language: yaml
|
@ -62,3 +62,13 @@ There are example BigchainDB transactions in
|
||||
:ref:`the HTTP API documentation <The HTTP Client-Server API>`
|
||||
and
|
||||
`the Python Driver documentation <https://docs.bigchaindb.com/projects/py-driver/en/latest/usage.html>`_.
|
||||
|
||||
|
||||
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>`.
|
||||
|
Loading…
x
Reference in New Issue
Block a user