152 Commits

Author SHA1 Message Date
tim
d748a1dc18 Minor corrections of redundant infos 2017-01-25 10:33:37 +01:00
tim
9a1b1364ea Add response headers 2017-01-25 10:33:37 +01:00
tim
152f151f23 :param _: --> :query _: 2017-01-25 10:33:07 +01:00
tim
eda8cdbba1 Add docs about /transactions endpoint 2017-01-25 10:33:07 +01:00
tim
f18f3cb8d2 Add sections to be done 2017-01-25 10:33:07 +01:00
tim
0a06547c1b Add transactions by metadata id endpoint 2017-01-25 10:33:07 +01:00
tim
ee904d78f4 Add transactions by asset id endpoint 2017-01-25 10:32:17 +01:00
tim
748e155378 Get block status using /statuses 2017-01-25 10:32:17 +01:00
tim
58d0b771cb id --> resource_id
Inevitably, some resources will not allow to filter by the exact
    keyword that is included in a resources body.

    Take for example asset and metadata.
    They both have a property called 'id', hence requests of a form:

        /transactions&fields=x,y&property_name=z

    might now be allowed to be resolved as the keyword 'id' in this
    case could reference both 'metadata.id' and 'asset.id'.

    This problem cannot be structurally resolved with URL paths.
    Hence it was decided to emphasize on a few resources that
    implement 'id' as a sort-of primary key.
2017-01-25 10:32:17 +01:00
tim
90aff0e202 Give up /conditions endpoint
A transaction contains:

        - conditions
        - fulfillments
        - assets
        - meta data

    While:

        - assets; and
        - meta data

    could be viewed as their own "tables" or resources, conditions
    and fulfillments cannot. Why?

    Because in comparison they do not contain a primary key, allowing
    them to be queried by it.
2017-01-25 10:32:17 +01:00
tim
156bf4fb21 txid --> id
KISS: A transaction is a resource as every other. Let's not give it
a special id (like 'txid'), but simply a regular id.
2017-01-25 10:32:17 +01:00
tim
9766332b8b Restructure doc: Endpoints as roots 2017-01-25 10:32:17 +01:00
tim
85d9553a1e owner_after --> owners_after
Querystring keywords should be in line with data model.
2017-01-25 10:31:25 +01:00
tim
e243a1be9b Use sphinx note for note in document 2017-01-25 10:31:25 +01:00
tim
0dc9b46ea7 Structural changes to the document
- Remove /unspents/ and replace with endpoint under /transactions
- Remove /transactions/txid/conditions/cid endpoint
2017-01-25 10:30:58 +01:00
tim
b488997353 tx_id --> txid 2017-01-25 10:29:12 +01:00
tim
5789a37664 Allow /statuses to return a 303 See Other response.
According to: https://www.ietf.org/rfc/rfc2616.txt a 303 See Other can
be returned to indicate that the resource the user is looking for can be
found under a new path.
In the case of a transaction including the `status == 'valid'`, we
return 303 See Other, as well as a Location header to the /transactions
endpoint.

"The response to the request can be found under a different URI and SHOULD be
retrieved using a GET method on that resource."
2017-01-25 10:29:12 +01:00
tim
71d3c70fda Status --> Statuses
Usage of singular resource names is discouraged in REST:
http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api

The plural of status is statuses:
http://english.stackexchange.com/questions/877/what-is-the-plural-form-of-status
2017-01-25 10:28:28 +01:00
tim
1086c3a5c4 POST /transactions status code to 202
According to https://www.ietf.org/rfc/rfc2616.txt a 201 Created status
code MUST only be returned when:

"The origin server MUST create the resource before returning the 201 status
code."

hence, a 202 Accepted's definition is more appropriate:

"The request has been accepted for processing, but the processing has not been
completed.

The entity returned with this response SHOULD include an indication of the
request's current status and either a pointer to a status monitor or some
estimate of when the user can expect the request to be fulfilled."
2017-01-25 10:27:52 +01:00
tim
f15a7f7e8b Document conditions endpoint 2017-01-25 10:23:14 +01:00
Troy McConaghy
2c78870d3a Merge pull request #1076 from bigchaindb/docs/1048/how-to-install-os-deps-for-fabric
Docs: Added instructions to install fabric's OS-level dependencies
2017-01-23 15:14:37 +01:00
Troy McConaghy
98fb15c124 Added instructions to install fabric's OS-level dependencies 2017-01-22 15:07:14 +01:00
Troy McConaghy
15d28e3f91 Quickstart now assumes you're using Ubuntu 16.04 or similar 2017-01-22 14:47:45 +01:00
Rodolphe Marques
e7ffcf5705 Added replicaset name to bigchaindb config (#1063)
* Added replicaset name to bigchaindb config

* changed travis replSet to match bigchaindb default

* Updated initialize_replica_set

It now initializes the replica set with the name provided by the
bigchaindb config file.


* initialize_replica_set is now called when creating a mongodb connection.

This way we are sure that a replica set exists when we return a
connection.

* Moved the initialize replica set logic to the connection.

* update the config documentation
2017-01-20 14:05:28 +01:00
libscott
8e497347d5 Merge pull request #1043 from bigchaindb/duplicate-asset-id
duplicate tx.id into tx.asset.id in CREATE transactions
2017-01-17 15:00:33 +01:00
Scott Sadler
47f09c0e67 documentation changes for duplicate asset id 2017-01-16 15:24:51 +01:00
Sylvain Bellemare
d71fdcbe78 Add backend admin sections to docs 2017-01-16 07:12:25 -05:00
libscott
b592786882 Merge pull request #1019 from bigchaindb/add_multiple_current_owners_for_doc
Add multiple current owners for doc
2017-01-10 11:11:18 +01:00
libscott
3d74bfbb89 Merge pull request #1014 from bigchaindb/884/sha3-2015
update pysha3 to 1.0b1, sha3 NIST 2015 standard
2017-01-05 11:58:49 +01:00
Scott Sadler
d714b133aa documentation fixes to inputs-outputs.rst 2017-01-05 10:15:35 +01:00
Scott Sadler
cadc9add39 fixups for 'multiple current owners' section in inputs/outputs docs 2017-01-04 15:39:10 +01:00
utarl
ab8579148c add multiple current owners 2017-01-04 10:49:07 +08:00
utarl
4266499263 change messy code 2017-01-04 10:44:30 +08:00
utarl
0c53a49405 change messy code 2017-01-04 10:36:10 +08:00
utarl
b8ae2132aa change messy code 2017-01-04 10:21:43 +08:00
utarl
c0d812f0d2 change messy code 2017-01-04 10:18:06 +08:00
utarl
4de0bb4c8c change messy code 2017-01-04 10:11:00 +08:00
utarl
96432ce0be add multiple current owners 2017-01-04 10:01:45 +08:00
troymc
ca14321a3e Added ENABLE_WEB_ADMIN config setting to AWS depl. configs 2017-01-03 17:05:24 +01:00
Scott Sadler
eeef08a43a mention version of pysha3 and link to pypi page instead 2017-01-03 17:04:43 +01:00
Scott Sadler
c31feaf83d update pysha3 to 1.0b1, sha3 NIST 2015 standard 2017-01-03 16:55:28 +01:00
Scott Sadler
04a78aacec Merge remote-tracking branch 'origin/master' into inputs-outputs 2016-12-22 13:45:02 +01:00
libscott
7e33f2bd52 Tx ID as Asset ID (#926)
* Allow AssetLinks to be used in place of Assets in the Transaction Model and enforce `Transaction.transfer()` to only take an AssetLink

* Remove AssetLink's inheritance from Asset

* Remove id from the Asset model

* Fix get_txids_by_asset_id query for rethinkdb after removing asset's uuid

Because `CREATE` transactions don't have an asset that contains an id
anymore, one way to find all the transactions related to an asset is to
query the database twice: once for the `CREATE` transaction and another
for the `TRANSFER` transactions.

* Add TODO notice for vote test utils to be fixtures

* Update asset model documentation to reflect usage of transaction id

* Fix outdated asset description in transaction schema
2016-12-20 17:28:15 +01:00
Troy McConaghy
8fa6789745 Merge pull request #965 from bigchaindb/move-all-runtests-docs-to-one-place
Consolidated all tests-related docs in one place
2016-12-20 14:02:52 +01:00
Brett Sun
ad6f267055 Add instructions for rebuilding docker images after upgrading 2016-12-20 13:52:46 +01:00
troymc
854d2974f5 Removed instructions for the case when PR #2884 wasn't merged 2016-12-20 11:33:47 +01:00
libscott
b2cb426097 Merge pull request #962 from bigchaindb/remove-asset-keywords
Remove asset keywords
2016-12-20 10:02:42 +01:00
Brett Sun
8470854769 Add extra set of backticks for code-blocks in inputs and outputs docs 2016-12-19 16:14:58 +01:00
Brett Sun
b64026441b Add changes from @ttmc's suggestions 2016-12-19 16:12:09 +01:00
Brett Sun
d412c934b1 Add extra sentence to inputs and outputs docs describing divisible assets 2016-12-19 16:04:31 +01:00