From d87f881eda84acd2542dc5601722903967a8bfc9 Mon Sep 17 00:00:00 2001 From: troymc Date: Mon, 20 Jun 2016 11:34:48 +0200 Subject: [PATCH] Docs: Added note about queries via the HTTP API --- docs/source/drivers-clients/http-client-server-api.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/drivers-clients/http-client-server-api.md b/docs/source/drivers-clients/http-client-server-api.md index 9160082e..e64018b9 100644 --- a/docs/source/drivers-clients/http-client-server-api.md +++ b/docs/source/drivers-clients/http-client-server-api.md @@ -1,11 +1,12 @@ # The HTTP Client-Server API +Note: The HTTP client-server API is currently quite rudimentary. For example, there is no ability to do complex queries using the HTTP API. We plan to add querying capabilities in the future. If you want to build a full-featured proof-of-concept, we suggest you use [the Python server API](../nodes/python-server-api-examples.html) for now. + When you start Bigchaindb using `bigchaindb start`, an HTTP API is exposed at: -- [http://localhost:9984/api/v1/](http://localhost:9984/api/v1/) +[http://localhost:9984/api/v1/](http://localhost:9984/api/v1/) - -Please note that for security reasons the server binds to `localhost:9984`. +For security reasons, the server binds to `localhost:9984`. If you want to bind the server to `0.0.0.0` we recommend you to read [Deploying Gunicorn](http://docs.gunicorn.org/en/stable/deploy.html) and follow the instructions to deploy it in production. @@ -14,5 +15,4 @@ The HTTP API currently exposes two endpoints, one to get information about a specific transaction id, and one to push a transaction to the BigchainDB cluster. Those endpoints are documented at: -- [http://docs.bigchaindb.apiary.io/](http://docs.bigchaindb.apiary.io/) - +[http://docs.bigchaindb.apiary.io/](http://docs.bigchaindb.apiary.io/)