211 Commits

Author SHA1 Message Date
Rodolphe Marques
69068fc919 Document how to run BigchainDB with MongoDB (#1116)
* Document changes in the configure command.

Document new add/remove replicas commands.

* updated quickstart with mongodb instructions

* Docs on how to setup mongodb dev node with and without docker.

Update replSet option in docker-compose

* Fixed typo.

More explicit on how to run the tests.

* Fixed typo in mongodb docker instructions.

More explicit about requiring mongodb 3.4+
2017-01-31 13:53:36 +01:00
Scott Sadler
adb579ac0a Revert "duplicate asset ID" and apply "get_txids_filtered" interface. 2017-01-26 13:52:09 +01:00
Sylvain Bellemare
05fdcef670 Document default value for GET /outputs?unspent= 2017-01-26 05:05:54 -05:00
tim
5b7dd672b8 Remove controversial endpoints for now 2017-01-25 11:30:40 +01:00
tim
7a71e386f3 Fix whitespace 2017-01-25 11:06:54 +01:00
Scott Sadler
88b99d7bdc document optional operation parameter in transaction 2017-01-25 11:06:54 +01:00
Scott Sadler
d932184b88 update http docs to reflect changes implemented for 0.9 2017-01-25 11:06:54 +01:00
Brett Sun
2d1699e790 Split block and transaction status endpoint descriptions 2017-01-25 10:44:06 +01:00
Brett Sun
787512014a Fix small typos in API docs 2017-01-25 10:44:06 +01:00
diminator
d68d70ebc3 improved documentation on statuses links and values 2017-01-25 10:44:06 +01:00
diminator
ec5000bd47 add curly brackets around url 2017-01-25 10:44:06 +01:00
diminator
4dea64f3be /transactions root endpoint returns 400 2017-01-25 10:44:06 +01:00
diminator
deba454eb0 400 OK -> bad request 2017-01-25 10:44:06 +01:00
diminator
a6facc8ada reformat blocks + blocks endpoint as list 2017-01-25 10:44:06 +01:00
diminator
86be0e5983 move blocks and votes to advanced with intro 2017-01-25 10:44:06 +01:00
diminator
4631c93dbf statuses remove 303 and location, links in payload 2017-01-25 10:44:06 +01:00
Dimitri De Jonghe
60b21fd24c add comma 2017-01-25 10:44:06 +01:00
Scott Sadler
9e163ed2e5 update api root informational endpoint docs 2017-01-25 10:44:06 +01:00
Dimitri De Jonghe
7d7a05c706 remove href from links 2017-01-25 10:44:06 +01:00
diminator
cb4207fb32 version 0.9 to api version 1 2017-01-25 10:44:06 +01:00
diminator
8bbaa0e40e status endpoint query params and remove links 2017-01-25 10:44:06 +01:00
diminator
6cf39542ea improve wording on post transactions status codes 2017-01-25 10:44:06 +01:00
diminator
fde3d21ba7 POST /transactions returns statuses payload 2017-01-25 10:43:17 +01:00
diminator
005a164e6b additional info on INVALID block 2017-01-25 10:43:17 +01:00
diminator
1ef2da7c32 mention history and provenance 2017-01-25 10:43:17 +01:00
diminator
9d6ca861a7 Note on retrieving the list of assets 2017-01-25 10:43:17 +01:00
diminator
7576210c82 remove GENESIS from operations 2017-01-25 10:43:17 +01:00
diminator
df94427cca fulfilled conditions -> unspent outputs 2017-01-25 10:43:17 +01:00
diminator
f17a722634 remove is_asset 2017-01-25 10:43:17 +01:00
diminator
9e5623f881 Removed X-bigchaindb-timestamp 2017-01-25 10:43:17 +01:00
diminator
5fa3cddbb7 transactions and blocks root endpoints 2017-01-25 10:43:17 +01:00
diminator
0ce9cc4f55 Return transaction if it's in backlog also 2017-01-25 10:42:32 +01:00
diminator
6aca7e2605 list assets recipe and sample 2017-01-25 10:42:32 +01:00
diminator
b252c40793 GET /votes examples -> samples 2017-01-25 10:42:32 +01:00
diminator
be5bc9fafd GET blocks?txid examples -> samples 2017-01-25 10:42:32 +01:00
diminator
e79a76512f remove rudimentary note and typo's 2017-01-25 10:42:32 +01:00
diminator
e54d50a58f Add docs links to root endpoints 2017-01-25 10:41:51 +01:00
diminator
21ffe22516 API root URL vs BigchainDB root URL 2017-01-25 10:39:21 +01:00
diminator
204c8cce9c GET blocks/id examples -> samples 2017-01-25 10:38:33 +01:00
diminator
5c10602754 examples -> samples POST /transaction and /statuses 2017-01-25 10:38:33 +01:00
diminator
35a7d11fb3 remove metadata query from endpoint -> see #856 2017-01-25 10:36:20 +01:00
diminator
b947cf7c72 GET transactions?operation&asset_id examples --> samples
Updated example to include more than one TRANSFER
2017-01-25 10:36:20 +01:00
diminator
a37b505c87 (fix): forgot one owners_after -> public_keys 2017-01-25 10:36:20 +01:00
diminator
d09a93f1a7 update GET transactions?unfulfilled
- owners_after -> public_keys
- examples -> samples
2017-01-25 10:36:20 +01:00
diminator
a8f8c7f4a9 GET transactions/id examples --> samples 2017-01-25 10:36:20 +01:00
diminator
56b4da02c9 (fix) : minor fixes to server docs for building 2017-01-25 10:36:20 +01:00
tim
6e25ef4598 Add retrieve votes by block 2017-01-25 10:36:20 +01:00
tim
df3ded315c Remove retrieve vote by vote_id
After talking to @r-marques and @libscott:

    - A vote's id is currently generated by RethinkDB
    - To verify a vote, the signature and the pubkey should be used
    - Vote's id will be removed from the "external" vote model in the
    future
    - Nobody would want to retrieve a vote, but rather a vote by block

In case of the HTTP API, this means that a /votes/vote_id endpoint is
not feasible to implement.
2017-01-25 10:36:20 +01:00
tim
0c651f6b11 Timestamp of block as header: /transactions/tx_id
For reasoning, see:
https://github.com/bigchaindb/bigchaindb/pull/830#issuecomment-262774345
2017-01-25 10:36:20 +01:00
tim
8e91e14e86 Add /blocks/{block_id} safety querystring
It didn't feel good letting users retrieve also invalid or undecided
blocks in the /blocks/{block_id} endpoint.

Hence, now a block can be evaluated by it's status.
If block_id and status do not match, a 404 Not Found HTTP status code is
returned.
Per default, status is set to valid only.
2017-01-25 10:36:20 +01:00