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

Updated metadata and asset model docs

Browse Source
This commit is contained in:
kansi 2017-11-06 12:06:01 +05:30
parent b93b3d2af8
commit 3cbec5a864
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/server/source/data-models/asset-model.md
View File

@ -18,3 +18,11 @@ In a `TRANSFER` transaction, the `"asset"` must contain exactly one key-value pa
"id": "38100137cea87fb9bd751e2372abb2c73e7d5bcf39d940a5516a324d9c7fb88d"
}
```
.. note::
When using MongoDB for storage certain restriction apply to all (including nested) keys of `"data"` JSON document i.e. valid keys should **not** begin with ``$`` character and cannot contain ``.`` or null character (Unicode code point 0000). Furthermore, the key `"language"` (at any level in the hierarchy) in `"data"` JSON document is a spcial key and used for specifying text search language. Its value must be one of the allowed values, see `Text search languages <https://docs.mongodb.com/manual/reference/text-search-languages/>`_ . It must be noted that only the languages supported by MongoDB community edition are allowed.

4
docs/server/source/data-models/transaction-model.rst
View File

@ -46,6 +46,10 @@ Here's some explanation of the contents:
- **metadata**: User-provided transaction metadata.
It can be any valid JSON document, or ``null``.
**NOTE** when using MongoDB for storage certain restriction apply to all
(including nested) keys of ``"metadata"`` JSON document i.e. valid keys
should **not** begin with ``$`` character and cannot contain ``.`` or
null character (Unicode code point 0000).
**How the transaction ID is computed.**
1) Build a Python dictionary containing ``version``, ``inputs``, ``outputs``, ``operation``, ``asset``, ``metadata`` and their values,