Dark-Alex-17/kapow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: markup {User,Control,Data} HTTP Interface as role any

Browse Source 
Also markup localhost:8080 as code, for consistency.

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
This commit is contained in:
pancho horrillo
2019-12-11 14:41:14 +01:00
parent bd1ea8f746
commit cb5ba7db43
4 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/concepts/interfaces.rst
+3 -3
View File
@@ -8,7 +8,7 @@ clear purpose.
User Interface
--------------
The User HTTP interface is used to serve final user requests.
The :any:`User HTTP Interface` is used to serve final user requests.
By default it binds to address ``0.0.0.0`` and port ``8080``, but that can be
changed via the ``--bind`` flag.
@@ -17,7 +17,7 @@ changed via the ``--bind`` flag.
Control Interface
-----------------
The Control HTTP interface is used by the command `kapow route` to
The :any:`Control HTTP Interface` is used by the command ``kapow route`` to
administer the list of system routes.
By default it binds to address ``127.0.0.1`` and port ``8081``, but that can be
@@ -27,7 +27,7 @@ changed via the ``--control-bind`` flag.
Data Interface
--------------
The Data HTTP interface is used by the commands ``kapow get`` and ``kapow
The :any:`Data HTTP Interface` is used by the commands ``kapow get`` and ``kapow
set`` to exchange the data for a particular request.
By default it binds to address ``127.0.0.1`` and port ``8082``, but that can be
docs/source/concepts/request_life_cycle.rst
+4 -4
View File
@@ -2,7 +2,7 @@ Request Life Cycle
==================
This section describes the sequence of events happening for each request
answered by the `User HTTP Interface`.
answered by the :any:`User HTTP Interface`.
.. image:: ../_static/request_life_cycle.png
@@ -10,7 +10,7 @@ answered by the `User HTTP Interface`.
1. request
----------
The user makes a request to the `User HTTP Interface`.
The user makes a request to the :any:`User HTTP Interface`.
- The request is matched against the route table.
@@ -30,8 +30,8 @@ The spawned entrypoint is run with the following variables added to its
environment:
- :envvar:`KAPOW_HANDLER_ID`: Containing the `HANDLER_ID`
- :envvar:`KAPOW_DATAAPI_URL`: With the URL of the `Data HTTP Interface`
- :envvar:`KAPOW_CONTROLAPI_URL`: With the URL of the `Control HTTP Interface`
- :envvar:`KAPOW_DATAAPI_URL`: With the URL of the :any:`Data HTTP Interface`
- :envvar:`KAPOW_CONTROLAPI_URL`: With the URL of the :any:`Control HTTP Interface`
3. ``kapow set /response/body banana``
docs/source/concepts/routes.rst
+1 -1
View File
@@ -2,7 +2,7 @@ Routes
======
A *Kapow!* route specifies the matching criteria for an incoming request on
the `User HTTP Interface`, and the details to handle it.
the :any:`User HTTP Interface`, and the details to handle it.
*Kapow!* implements a *route table* where all routes reside.