38 Commits

Author SHA1 Message Date
Troy McConaghy
8e5f770707 List the "blocks" endpoint in response to HTTP info requests (#2545)
* Problem: HTTP info endpoints don't include "blocks"

Solution: Add "blocks" to the response to the HTTP info endpoints

* Removed "blocks" endpoints from "Advanced Usage"
because they are really not that advanced
2018-09-17 14:06:48 +02:00
Lev Berman
9bf09324df Problem: Txs posted in async/sync can be lost. (#2514)
Solution: Document when the transactions posted in the async and sync modes can be lost. Describe how they are stored. Mention that BigchainDB does not store or expose rejected transactions.
2018-09-05 17:18:17 +02:00
Troy McConaghy
d78ff75225 Problem: HTTP API docs wrong regarding the mode parameter (#2481)
Solution: Edit those docs to be accurate
2018-08-27 15:01:55 +02:00
Troy McConaghy
4815e75855 Problem: People reading HTTP API docs not told about the option to query MongoDB directly (#2463)
Solution: Tell them
2018-08-21 10:26:39 +02:00
Troy McConaghy
abdd23f5a6 Problem: Source files contain no license info (#2455)
* Problem: Source files contain no license info

Solution: Add comments with SPDX license info to source files

* Python 3 files don't need # -*- coding: utf-8 -*-
2018-08-16 12:31:32 +02:00
Troy McConaghy
4806b81577 Problem: Inconsistent HTTP API docs (#2403)
- Make the title of the asset search section consistent with the example (and consistent with the metadata search title and example).
- Add a note that one can use `asset?search` or `asset/?search`, and the same for metadata.
2018-08-09 11:14:48 +02:00
Troy McConaghy
acc2710d7b Problem: There are old links to the IPDB tx spec (#2290)
Solution: Replace those links with appropriate links to the BigchainDB Transactions Specs
2018-05-24 01:36:43 +02:00
Vanshdeep Singh
ef26220c7f Problem: Docs for BEP#3 implementation not updated (#2123)
* Problem: Docs for BEP#3 implementation not updated

Solutions: Update docs for #2070 and #2106

* Problem: 'Validator update' docs language not clear

Solution: Re-write the documentation which explains when validators are updated

* Problem: Typos and BEP reference missing

Solution: Fix typos and add BEP reference
2018-03-21 09:23:08 +01:00
Troy McConaghy
497e1039ef
Merge branch 'tendermint' into text-edits-in-http-api-docs 2018-02-22 21:02:33 +01:00
Ahmed Muawia Khan
5669514ee7 Fix label docs 2018-02-21 12:13:45 +01:00
Ahmed Muawia Khan
669b2d586b Merge branch 'tendermint' into tendermint-docs-k8s-dep 2018-02-21 11:48:02 +01:00
Troy McConaghy
e1bdd41030 Copy-edited the HTTP API docs 2018-02-19 16:33:46 +01:00
Troy McConaghy
7f94242f85 Update all docs re/ votes when Tendermint integrated 2018-02-16 16:24:44 +01:00
Troy McConaghy
7c3d7f4f63 Tidy up some grammar and Tendermint refs 2018-02-16 14:53:30 +01:00
Troy McConaghy
9ef2271a5d In HTTP API docs, removed all /statuses & /votes endpoints 2018-02-16 14:31:26 +01:00
kansi
6cf86be033 Remove location header from post txn response 2018-02-16 18:42:06 +05:30
muawiakh
d6a7500abc Resolved merge conflicts with tendermint branch 2018-02-08 15:52:31 +01:00
Vanshdeep Singh
fa33fc26af Integrate get block with transaction id api (#2021)
* Integrate api, get block with transaction id

* Fixed docs and docstrings

* Fix docs

* Remove status from tendermint, fix mongo query
2018-02-08 14:32:21 +01:00
Vanshdeep Singh
e25d365828 Integrate blocks API (#1970)
* Integrate blocks api

* Update docs

* Fix docs

* Fixed mismatch between code and documentation

* Fixed docs
2018-01-31 14:42:41 +01:00
Troy McConaghy
328f2ed193 Some minor copy-editing 2018-01-24 16:43:35 +01:00
codegeschrei
e74fb096fc requested changes 2018-01-24 11:59:50 +01:00
codegeschrei
06a091e215 add mode parameter to transaction endpoint, fixes #1995 2018-01-11 13:26:06 +01:00
muawiakh
14892fc839 Template for BigchainDB + Tendermint Kubernetes Deployment
- Template doc for BigchainDB + Tendermint single node
- Template doc for BigchainDB + Tendermint network
- Remove autosectionlabel extension from docs/server/source/conf.py
  - Removed this extension because this does not allow two different
    documents to have same headings, because it auto-indexes
- Fix and explicitly label headings and references.
2018-01-10 14:20:32 +01:00
kansi
4eca26782c Change metadata model, fix tests and update docs 2017-11-14 00:13:06 +05:30
libscott
b1ad6045b6 Rename "output" to "output_index" in /api/v1/outputs (#1596)
* rename output to output_index in /api/v1/outputs

* rename transaction.input.fulfills.output to output_index

* fix rethinkdb queries for output_index
2017-06-30 09:40:50 +02:00
Rodolphe Marques
842664cb14 Improved documentation
- fixed test name
2017-06-16 10:31:46 +02:00
Rodolphe Marques
b523ba3fe5 Rename unspent -> spent in outputs endpoint
- If spent=None return all outputs
- If spent=True return only spent outputs
- If spent=False return only unspent outputs
- Updated documentation
- Add the ability to return only spent outputs in core
- Added and update tests
2017-06-16 10:31:46 +02:00
Rodolphe Marques
4d1131d90c Remove links from statuses endpoint
- Updated documentation
- Updated tests
2017-06-16 10:01:45 +02:00
Rodolphe Marques
446e454a77 outputs endpoint returns list of objects instead of links
- Updated documentation
- Updated tests
2017-06-16 10:01:45 +02:00
Rodolphe Marques
dda6517451 Merge pull request #1532 from bigchaindb/feat/1531/consistent-naming
Consistent naming of `transaction_id`
2017-06-16 09:50:43 +02:00
Troy McConaghy
0f4998ef16 changed hard-coded URL in docs link to a :ref: 2017-06-15 10:04:49 +02:00
tim
275f29cfe4 Add note for polling and WS API when POST /transactions 2017-06-14 17:40:12 +02:00
tim
eb791aa2ce Include Location header in POST /transactions 2017-06-14 16:53:22 +02:00
tim
6cedab47a1 /transactions/ID only returns VALID transactions 2017-06-14 15:42:04 +02:00
Rodolphe Marques
7ffea9e8a4 Renamed tx_id to transaction_id
- Documentation
- Api
2017-06-13 12:24:04 +02:00
Tim Daubenschütz
8b7f86b63d Feat/1462/text search http api (#1471)
* Add assets text search endpoint

* Filter out assets from invalid transactions.

- Added the limit argument to limit the returned results
- Created and updated tests

* Added documentation for the assets endpoint.

- Added some docstrings

* Removed unnecessary fixtures
2017-05-30 11:21:26 +02:00
Troy McConaghy
59be30187f Merge branch 'master' into docs/1170/move-http-api-docs-to-top-level-section 2017-04-18 10:43:02 +02:00
Troy McConaghy
b4988b29e3 Moved HTTP API docs to a top-level section 2017-04-10 13:58:58 +02:00