updated links to the HTTP API docs in this repo

This commit is contained in:
Troy McConaghy 2017-04-10 15:14:18 +02:00
parent b4988b29e3
commit 8964ba33b4
8 changed files with 8 additions and 16 deletions

View File

@ -1,8 +1,6 @@
"""This module provides the blueprint for the blocks API endpoints.
For more information please refer to the documentation on ReadTheDocs:
- https://docs.bigchaindb.com/projects/server/en/latest/drivers-clients/
http-client-server-api.html
For more information please refer to the documentation: http://bigchaindb.com/http-api
"""
from flask import current_app
from flask_restful import Resource, reqparse

View File

@ -33,7 +33,7 @@ class ApiV1Index(Resource):
docs_url = [
'https://docs.bigchaindb.com/projects/server/en/v',
version.__version__,
'/drivers-clients/http-client-server-api.html',
'/http-client-server-api.html',
]
return {
'_links': {

View File

@ -1,8 +1,6 @@
"""This module provides the blueprint for the statuses API endpoints.
For more information please refer to the documentation on ReadTheDocs:
- https://docs.bigchaindb.com/projects/server/en/latest/drivers-clients/
http-client-server-api.html
For more information please refer to the documentation: http://bigchaindb.com/http-api
"""
from flask import current_app
from flask_restful import Resource, reqparse

View File

@ -1,8 +1,6 @@
"""This module provides the blueprint for some basic API endpoints.
For more information please refer to the documentation on ReadTheDocs:
- https://docs.bigchaindb.com/projects/server/en/latest/drivers-clients/
http-client-server-api.html
For more information please refer to the documentation: http://bigchaindb.com/http-api
"""
import logging

View File

@ -1,8 +1,6 @@
"""This module provides the blueprint for the votes API endpoints.
For more information please refer to the documentation on ReadTheDocs:
- https://docs.bigchaindb.com/projects/server/en/latest/drivers-clients/
http-client-server-api.html
For more information please refer to the documentation: http://bigchaindb.com/http-api
"""
from flask import current_app
from flask_restful import Resource, reqparse

View File

@ -53,7 +53,7 @@ At a high level, one can communicate with a BigchainDB cluster (set of nodes) us
</style>
<div class="buttondiv">
<a class="button" href="http://docs.bigchaindb.com/projects/server/en/latest/drivers-clients/http-client-server-api.html">HTTP API Docs</a>
<a class="button" href="http://bigchaindb.com/http-api">HTTP API Docs</a>
</div>
<div class="buttondiv">
<a class="button" href="http://docs.bigchaindb.com/projects/py-driver/en/latest/index.html">Python Driver Docs</a>

View File

@ -124,7 +124,7 @@ If you used `bigchaindb -y configure mongodb` to create a default local config f
## server.bind, server.workers & server.threads
These settings are for the [Gunicorn HTTP server](http://gunicorn.org/), which is used to serve the [HTTP client-server API](../drivers-clients/http-client-server-api.html).
These settings are for the [Gunicorn HTTP server](http://gunicorn.org/), which is used to serve the [HTTP client-server API](../http-client-server-api.html).
`server.bind` is where to bind the Gunicorn HTTP server socket. It's a string. It can be any valid value for [Gunicorn's bind setting](http://docs.gunicorn.org/en/stable/settings.html#bind). If you want to allow IPv4 connections from anyone, on port 9984, use '0.0.0.0:9984'. In a production setting, we recommend you use Gunicorn behind a reverse proxy server. If Gunicorn and the reverse proxy are running on the same machine, then use 'localhost:PORT' where PORT is _not_ 9984 (because the reverse proxy needs to listen on port 9984). Maybe use PORT=9983 in that case because we know 9983 isn't used. If Gunicorn and the reverse proxy are running on different machines, then use 'A.B.C.D:9984' where A.B.C.D is the IP address of the reverse proxy. There's [more information about deploying behind a reverse proxy in the Gunicorn documentation](http://docs.gunicorn.org/en/stable/deploy.html). (They call it a proxy.)

View File

@ -23,7 +23,7 @@ def test_api_root_endpoint(client):
def test_api_v1_endpoint(client):
res = client.get('/api/v1')
docs_url = ['https://docs.bigchaindb.com/projects/server/en/vtsttst',
'/drivers-clients/http-client-server-api.html',
'/http-client-server-api.html',
]
assert res.json == {
'_links': {