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

Problem: People reading HTTP API docs not told about the option to query MongoDB directly

Browse Source 
Solution: Tell them
This commit is contained in:
Troy McConaghy 2018-08-15 14:02:34 +02:00
parent 3092beb995
commit 30cb0720bf
1 changed files with 35 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/server/source/http-client-server-api.rst
View File

@ -46,6 +46,15 @@ that allows you to discover the BigchainDB API endpoints:
Transactions Transactions
------------ ------------
.. note::
If you want to do more sophisticated queries
than those provided by the BigchainDB HTTP API,
then one option is to connect to MongoDB directly (if possible)
and do whatever queries MongoDB allows.
For more about that option, see
`the page about querying BigchainDB <https://docs.bigchaindb.com/en/latest/query.html>`_.
.. http:get:: /api/v1/transactions/{transaction_id} .. http:get:: /api/v1/transactions/{transaction_id}
Get the transaction with the ID ``transaction_id``. Get the transaction with the ID ``transaction_id``.
@ -179,6 +188,14 @@ The ``/api/v1/outputs`` endpoint returns transactions outputs filtered by a
given public key, and optionally filtered to only include either spent or given public key, and optionally filtered to only include either spent or
unspent outputs. unspent outputs.
.. note::
If you want to do more sophisticated queries
than those provided by the BigchainDB HTTP API,
then one option is to connect to MongoDB directly (if possible)
and do whatever queries MongoDB allows.
For more about that option, see
`the page about querying BigchainDB <https://docs.bigchaindb.com/en/latest/query.html>`_.
.. http:get:: /api/v1/outputs .. http:get:: /api/v1/outputs
@ -289,6 +306,15 @@ unspent outputs.
Assets Assets
------ ------
.. note::
If you want to do more sophisticated queries
than those provided by the BigchainDB HTTP API,
then one option is to connect to MongoDB directly (if possible)
and do whatever queries MongoDB allows.
For more about that option, see
`the page about querying BigchainDB <https://docs.bigchaindb.com/en/latest/query.html>`_.
.. http:get:: /api/v1/assets .. http:get:: /api/v1/assets
Return all the assets that match a given text search. Return all the assets that match a given text search.
@ -297,10 +323,6 @@ Assets
:query int limit: (Optional) Limit the number of returned assets. Defaults :query int limit: (Optional) Limit the number of returned assets. Defaults
to ``0`` meaning return all matching assets. to ``0`` meaning return all matching assets.
.. note::
Currently this endpoint is only supported if using MongoDB.
.. http:get:: /api/v1/assets/?search={search} .. http:get:: /api/v1/assets/?search={search}
Return all assets that match a given text search. Return all assets that match a given text search.
@ -408,6 +430,15 @@ Assets
Transaction Metadata Transaction Metadata
-------------------- --------------------
.. note::
If you want to do more sophisticated queries
than those provided by the BigchainDB HTTP API,
then one option is to connect to MongoDB directly (if possible)
and do whatever queries MongoDB allows.
For more about that option, see
`the page about querying BigchainDB <https://docs.bigchaindb.com/en/latest/query.html>`_.
.. http:get:: /api/v1/metadata .. http:get:: /api/v1/metadata
Return all the metadata objects that match a given text search. Return all the metadata objects that match a given text search.
@ -416,10 +447,6 @@ Transaction Metadata
:query int limit: (Optional) Limit the number of returned metadata objects. Defaults :query int limit: (Optional) Limit the number of returned metadata objects. Defaults
to ``0`` meaning return all matching objects. to ``0`` meaning return all matching objects.
.. note::
Currently this endpoint is only supported if using MongoDB.
.. http:get:: /api/v1/metadata/?search={search} .. http:get:: /api/v1/metadata/?search={search}
Return all metadata objects that match a given text search. Return all metadata objects that match a given text search.