mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
8b7f86b63d
* 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
51 lines
1.5 KiB
Python
51 lines
1.5 KiB
Python
"""This module provides the blueprint for some basic API endpoints.
|
|
|
|
For more information please refer to the documentation: http://bigchaindb.com/http-api
|
|
"""
|
|
import logging
|
|
|
|
from flask_restful import reqparse, Resource
|
|
from flask import current_app
|
|
|
|
from bigchaindb.backend.exceptions import OperationError
|
|
from bigchaindb.web.views.base import make_error
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class AssetListApi(Resource):
|
|
def get(self):
|
|
"""API endpoint to perform a text search on the assets.
|
|
|
|
Args:
|
|
search (str): Text search string to query the text index
|
|
limit (int, optional): Limit the number of returned documents.
|
|
|
|
Return:
|
|
A list of assets that match the query.
|
|
"""
|
|
parser = reqparse.RequestParser()
|
|
parser.add_argument('search', type=str, required=True)
|
|
parser.add_argument('limit', type=int)
|
|
args = parser.parse_args()
|
|
|
|
if not args['search']:
|
|
return make_error(400, 'text_search cannot be empty')
|
|
if not args['limit']:
|
|
# if the limit is not specified do not pass None to `text_search`
|
|
del args['limit']
|
|
|
|
pool = current_app.config['bigchain_pool']
|
|
|
|
with pool() as bigchain:
|
|
assets = bigchain.text_search(**args)
|
|
|
|
try:
|
|
# This only works with MongoDB as the backend
|
|
return list(assets)
|
|
except OperationError as e:
|
|
return make_error(
|
|
400,
|
|
'({}): {}'.format(type(e).__name__, e)
|
|
)
|