Moved HTTP API docs to a top-level section

.gitignore

@@ -78,7 +78,7 @@ ntools/one-m/ansible/ansible.cfg
 
 # Just in time documentation
 docs/server/source/schema
-docs/server/source/drivers-clients/samples
+docs/server/source/http-samples
 
 # Terraform state files
 # See https://stackoverflow.com/a/41482391

docs/server/generate_http_server_api_documentation.py

@@ -269,7 +269,7 @@ def main():
     ctx['block_list'] = pretty_json(block_list)
 
     base_path = os.path.join(os.path.dirname(__file__),
-                             'source/drivers-clients/samples')
+                             'source/http-samples')
     if not os.path.exists(base_path):
         os.makedirs(base_path)
 

docs/server/source/drivers-clients/index.rst

@@ -14,13 +14,12 @@ community projects listed below.
 .. toctree::
    :maxdepth: 1
 
-   http-client-server-api
    websocket-event-stream-api
    The Python Driver <https://docs.bigchaindb.com/projects/py-driver/en/latest/index.html>
    Transaction CLI <https://docs.bigchaindb.com/projects/cli/en/latest/>
 
 
-Community Driven Libraries and Tools
+Community-Driven Libraries and Tools
 ------------------------------------
 Please note that some of these projects may be work in progress, but may
 nevertheless be very useful.

docs/server/source/http-client-server-api.rst

@@ -22,7 +22,7 @@ or ``https://example.com:9984``
 then you should get an HTTP response
 with something like the following in the body:
 
-.. literalinclude:: samples/index-response.http
+.. literalinclude:: http-samples/index-response.http
     :language: http
 
 
@@ -35,7 +35,7 @@ or ``https://example.com:9984/api/v1/``,
 then you should get an HTTP response
 that allows you to discover the BigchainDB API endpoints:
 
-.. literalinclude:: samples/api-index-response.http
+.. literalinclude:: http-samples/api-index-response.http
     :language: http
 
 
@@ -58,12 +58,12 @@ Transactions
 
    **Example request**:
 
-   .. literalinclude:: samples/get-tx-id-request.http
+   .. literalinclude:: http-samples/get-tx-id-request.http
       :language: http
 
    **Example response**:
 
-   .. literalinclude:: samples/get-tx-id-response.http
+   .. literalinclude:: http-samples/get-tx-id-response.http
       :language: http
 
    :resheader Content-Type: ``application/json``
@@ -110,12 +110,12 @@ Transactions
 
    **Example request**:
 
-   .. literalinclude:: samples/get-tx-by-asset-request.http
+   .. literalinclude:: http-samples/get-tx-by-asset-request.http
       :language: http
 
    **Example response**:
 
-   .. literalinclude:: samples/get-tx-by-asset-response.http
+   .. literalinclude:: http-samples/get-tx-by-asset-response.http
       :language: http
 
    :resheader Content-Type: ``application/json``
@@ -139,12 +139,12 @@ Transactions
 
    **Example request**:
 
-   .. literalinclude:: samples/post-tx-request.http
+   .. literalinclude:: http-samples/post-tx-request.http
       :language: http
 
    **Example response**:
 
-   .. literalinclude:: samples/post-tx-response.http
+   .. literalinclude:: http-samples/post-tx-response.http
       :language: http
 
    :resheader Content-Type: ``application/json``
@@ -227,12 +227,12 @@ Statuses
 
    **Example request**:
 
-   .. literalinclude:: samples/get-statuses-tx-request.http
+   .. literalinclude:: http-samples/get-statuses-tx-request.http
       :language: http
 
    **Example response**:
 
-   .. literalinclude:: samples/get-statuses-tx-valid-response.http
+   .. literalinclude:: http-samples/get-statuses-tx-valid-response.http
       :language: http
 
    :resheader Content-Type: ``application/json``
@@ -250,17 +250,17 @@ Statuses
 
    **Example request**:
 
-   .. literalinclude:: samples/get-statuses-block-request.http
+   .. literalinclude:: http-samples/get-statuses-block-request.http
       :language: http
 
    **Example response**:
 
-   .. literalinclude:: samples/get-statuses-block-invalid-response.http
+   .. literalinclude:: http-samples/get-statuses-block-invalid-response.http
       :language: http
 
    **Example response**:
 
-   .. literalinclude:: samples/get-statuses-block-valid-response.http
+   .. literalinclude:: http-samples/get-statuses-block-valid-response.http
       :language: http
 
    :resheader Content-Type: ``application/json``
@@ -298,12 +298,12 @@ Blocks
 
    **Example request**:
 
-   .. literalinclude:: samples/get-block-request.http
+   .. literalinclude:: http-samples/get-block-request.http
       :language: http
 
    **Example response**:
 
-   .. literalinclude:: samples/get-block-response.http
+   .. literalinclude:: http-samples/get-block-response.http
       :language: http
 
 
@@ -353,12 +353,12 @@ Blocks
 
    **Example request**:
 
-   .. literalinclude:: samples/get-block-txid-request.http
+   .. literalinclude:: http-samples/get-block-txid-request.http
       :language: http
 
    **Example response**:
 
-   .. literalinclude:: samples/get-block-txid-response.http
+   .. literalinclude:: http-samples/get-block-txid-response.http
       :language: http
 
    :resheader Content-Type: ``application/json``
@@ -384,12 +384,12 @@ Votes
 
    **Example request**:
 
-   .. literalinclude:: samples/get-vote-request.http
+   .. literalinclude:: http-samples/get-vote-request.http
       :language: http
 
    **Example response**:
 
-   .. literalinclude:: samples/get-vote-response.http
+   .. literalinclude:: http-samples/get-vote-response.http
       :language: http
 
    :resheader Content-Type: ``application/json``

docs/server/source/index.rst

@@ -11,6 +11,7 @@ BigchainDB Server Documentation
    nodes/index
    dev-and-test/index
    server-reference/index
+   http-client-server-api
    drivers-clients/index
    clusters-feds/index
    data-models/index