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: Inconsistent HTTP API docs

Browse Source 
- 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.
This commit is contained in:
Troy McConaghy 2018-07-24 14:23:14 +02:00 committed by GitHub
parent 12740686e9
commit b0d3f45dab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -301,7 +301,7 @@ Assets
Currently this endpoint is only supported if using MongoDB. 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.
@ -310,6 +310,10 @@ Assets
The ``id`` of the asset The ``id`` of the asset
is the same ``id`` of the CREATE transaction that created the asset. is the same ``id`` of the CREATE transaction that created the asset.
.. note::
You can use ``assets/?search`` or ``assets?search``.
If no assets match the text search it returns an empty list. If no assets match the text search it returns an empty list.
If the text string is empty or the server does not support text search, If the text string is empty or the server does not support text search,
@ -425,6 +429,10 @@ Transaction Metadata
The ``id`` of the metadata The ``id`` of the metadata
is the same ``id`` of the transaction where it was defined. is the same ``id`` of the transaction where it was defined.
.. note::
You can use ``metadata/?search`` or ``metadata?search``.
If no metadata objects match the text search it returns an empty list. If no metadata objects match the text search it returns an empty list.
If the text string is empty or the server does not support text search, If the text string is empty or the server does not support text search,