785 Commits

Author SHA1 Message Date
Scott Sadler
18d018519f remove Condition.cid and Fulfillment.fid in favour of dereferencing conditions and fulfillments by their location in their respective arrays 2016-11-29 09:59:43 +01:00
troymc
95f605287f Added clarity to TRANSFER Transactions section of the Transaction Concepts page 2016-11-28 17:55:13 +01:00
Scott Sadler
a6eb52d76d disallow empty metadata dict in favour of null 2016-11-28 17:34:46 +01:00
Scott Sadler
71dcee019f Remove metadata uuid 2016-11-28 17:34:46 +01:00
troymc
47fbd2b1ee Updated asset-model.md docs re/ divisible assets 2016-11-26 12:18:51 +01:00
troymc
3a410b33ed Updated Transactions Concepts docs re/ divisible assets 2016-11-26 12:18:18 +01:00
troymc
34bbf4d31a Updated assets.rst docs re/ divisible assets 2016-11-26 12:17:45 +01:00
Troy McConaghy
97c3380c2c Removed trailing comma inside vote JSON 2016-11-24 15:59:58 +01:00
Troy McConaghy
3e8f4b40e9 Merge pull request #863 from bigchaindb/bump-sphinx-for-readthedocs
bump sphinx version to 1.4.8 and add sphinxcontrib-napoleon to setup.…
2016-11-24 14:35:01 +01:00
Scott Sadler
8f47ec2796 bump sphinx version to 1.4.8 and add sphinxcontrib-napoleon to setup.py:docs_require 2016-11-24 14:33:59 +01:00
Scott Sadler
db673838fd remove distracting para from transaction-model.rst docs 2016-11-24 10:09:26 +01:00
Scott Sadler
a002c38009 updating wording for transaction creation in transaction-model.rst 2016-11-24 10:08:06 +01:00
Scott Sadler
0ab6e2b432 fix duplicate label in aws testing cluster docs 2016-11-24 10:06:36 +01:00
Scott Sadler
85b3422799 leave link to Data Models in root section with hard link 2016-11-24 10:01:20 +01:00
Scott Sadler
01037a0b82 fix warning generated in schema/transaction.rst 2016-11-23 16:14:27 +01:00
Scott Sadler
c8228d7ff7 move 'Data Models' from root to server docs and make links to schema 2016-11-23 16:14:11 +01:00
Troy McConaghy
7cbcd4d502 Put timestamps back in docs/root/source/index.rst
The docs page about timestamps in BigchainDB was temporarily removed from the docs by PR #817. The timestamps.md file itself was put back (and edited) but it was never put back in the index. This commit puts it back in the index.
2016-11-22 14:29:00 +01:00
troymc
17322b1e3a Addressed all comments by @sohkai in new Azure template page 2016-11-22 13:59:17 +01:00
Scott Sadler
22d267efe4 mention assignment_timestamp by name in timestamps.md 2016-11-22 13:05:25 +01:00
Scott Sadler
59394233b2 timestamps.md "many associated timestamps" 2016-11-22 13:03:30 +01:00
Scott Sadler
51452dea57 changes to timestamps.md documentation 2016-11-22 13:03:30 +01:00
Scott Sadler
33bafc341a put back timestamps.md 2016-11-22 13:03:30 +01:00
Scott Sadler
7dc9f52fe0 remove transaction timestamp 2016-11-22 13:03:30 +01:00
libscott
8343bab89f Schema definition (#798)
Commit messages for posterity:

* wip transaction schema definition
* test for SchemaObject
* test SchemaObject definions meta property
* schema documentation updates
* test for basic validation
* commit before change to .json file definiton + rst generation
* move to straight .json schema, test for additionalProperties on each object
* add asset to transaction definiton
* remove outdated tx validation
* make all tests pass
* create own exception for validation error and start validating transactions
* more tx validation fixes
* move to yaml file for schema
* automatic schema documentation generator
* remove redundant section
* use YAML safe loading
* change current_owners to owners_before in tx schema
* re-run tests and make correct yaml schema
* fix some broken tests
* update Release_Process.md
* move tx validation into it's own method
* add jsonschema dependency
* perform schema validation after ID validation on Transaction
* Release_Process.md, markdown auto numbering
* remove old transaction.json
* resolve remaining TODOs in schema docuementation
* add `id` and `$schema` to transaction.yaml
* add transaction.yaml to setup.py so it gets copied
* address some concernes in PR for transaction.yaml
* address more PR concerns in transaction.yaml
* refactor validtion exceptions and move transaction schema validation into it's own function in bigchaindb.common.schema.__init__
* add note to generated schema.rst indicating when and how it's generated
* move tx schema validation back above ID validation in Transaction.validate_structure, test that structurally invalid transaction gets caught and 400 returned in TX POST handler
* remove timestamp from transaction schema index
* Add README.md to bigchaindb.common.schema for introduction to JSON Schema and reasons for YAML
* Use constant for schema definitions' base prefix
* Move import of ValidationError exception into only the tests that require it
* Move validate transaction test helper to tests/common/util.py
* move ordered transaction schema load to generate_schema_documentation.py where it's needed
* use double backticks to render terms in schema docs
* change more backticks and change transaction version description in transaction schema
* make details a mandatory property of condition
* Many more documentation fixes
* rename schema.rst to schema/transaction.rst
* Fix documentation for Metadata
* Add more links to documentation
* Various other documentation fixes
* Rename section titles in rendered documentation
* use  to manage file handle
* fix extrenuous comma in test_tx_serialization_with_incorrect_hash args
* 'a' * 64
* remove schema validation until we can analyze properly impact on downstream consumers
* fix flake8 error
* use `with` always
2016-11-22 11:17:06 +01:00
troymc
03406d2760 docs: azure template -> old & new azure templates 2016-11-21 16:41:53 +01:00
Troy McConaghy
8f24e10fdc Docs: Noted unspents endpoint not yet implemented 2016-11-20 14:03:42 +01:00
Troy McConaghy
950ce9150a Merge pull request #813 from bigchaindb/feat/773/update-aws-deployment-scripts-to-ubuntu-16.04
Updated example AWS deployment config file to use Ubuntu 16.04 LTS
2016-11-17 16:13:02 +01:00
Rodolphe Marques
eead7dbdda Merge remote-tracking branch 'origin/master' into feat/746/new-naming-convention-for-keys 2016-11-17 11:41:23 +01:00
Scott Sadler
9b4252a6c9 wording change to drivers&clients doc as requested by @ttmc 2016-11-16 15:28:01 +01:00
Scott Sadler
9951b61076 add some explanation to the client-drivers documentation page. 2016-11-16 15:28:01 +01:00
Scott Sadler
44e80ce2a0 link to CLI from drivers and clients section of documentation 2016-11-16 15:28:01 +01:00
Scott Sadler
1ead2ea0f1 add a button to the docs linking to the bdb cli 2016-11-16 15:27:13 +01:00
Troy McConaghy
81250e6059 Docs/826/direct link from server docs to py driver docs (#827)
* Removed python-driver.md page in server docs

* In server docs, changed Py Driver docs link to a direct link
2016-11-16 14:24:05 +01:00
troymc
29d783425d Remove or comment-out the api_endpoint setting everywhere 2016-11-15 17:05:09 +01:00
troymc
5bf213d873 Removed api_endpoint from HTTP API docs & wrote how API Root URL is truly determined 2016-11-15 16:20:18 +01:00
tim
5ef532976d Corrections to render sphinx correctly 2016-11-15 13:46:39 +01:00
tim
f82f1add03 TransactionLinks --> URIs 2016-11-15 13:18:25 +01:00
tim
284411d881 PR Feedback 2016-11-15 13:18:25 +01:00
tim
93f3e9a06b Document unspents endpoint 2016-11-15 13:18:25 +01:00
tim
74b1662a78 Format http api docs to 79 chars 2016-11-15 13:18:25 +01:00
troymc
38e28d80e5 Changed example AWS deployment config file to use an Ubuntu 16.04 AMI & updated docs 2016-11-13 14:59:40 +01:00
tim
1c8fec730c Format http api docs to 79 chars 2016-11-11 15:38:28 +01:00
Rodolphe Marques
3909538c62 Replace all occurrences where vk is used as a shortcut
for public key and replaced it with `pk`
2016-11-10 17:20:27 +01:00
Rodolphe Marques
c068f04a82 Replaced VerifyingKey with PublicKey
Replaced SigningKey with PrivateKey
Replaced all occurences of signing key with private key
Replaced all occurences of verifying key with public key
2016-11-10 17:01:06 +01:00
MinchinWeb
658aa117c0 Remove sphinxcontrib-napoleon from doc requirements
As of Sphinx 1.3, this is included in the the core Sphinx package
2016-11-02 09:29:05 +01:00
Troy McConaghy
dc1d23f7d0 Merge pull request #777 from bigchaindb/bug/767/fix-link-to-conditions-and-fulfillments
Fixed three broken links in page about the transaction model
2016-11-01 19:54:33 +01:00
Troy McConaghy
a66f3b293e Merge pull request #766 from bigchaindb/expand-tx-validation-explanation
Expanded/updated the docs explaining transaction validation
2016-11-01 18:20:39 +01:00
troymc
ad65115b48 Fixed three broken links in page about the transaction model 2016-11-01 13:50:17 +01:00
troymc
e86f52fa15 Security: updated the Ubuntu AMI in example_deploy_config.py 2016-10-31 14:22:31 +01:00
troymc
78694b65d8 Expanded/updated the docs explaining tx validation 2016-10-30 12:11:07 +01:00