spec: add clarification for the entrypoint concept
Co-authored-by: César Gallego Rodríguez <cesar.gallego.next@bbva.com> Thanks to @hhurtado for providing us with invaluable feedback!
This commit is contained in:
+14
-1
@@ -96,6 +96,18 @@ TODO: Definition
|
|||||||
TODO: Intro to Architecture
|
TODO: Intro to Architecture
|
||||||
|
|
||||||
|
|
||||||
|
### Core Concepts
|
||||||
|
|
||||||
|
In this section we are going to define several concepts that will be used frequently throughout the spec.
|
||||||
|
|
||||||
|
|
||||||
|
#### `entrypoint`
|
||||||
|
|
||||||
|
The entrypoint definition matches *Docker*'s shell form of it.
|
||||||
|
Technically it's a string which is to be passed to the `command` (`/bin/bash -c`
|
||||||
|
by default) as the code to be interpreted or executed when attending requests.
|
||||||
|
|
||||||
|
|
||||||
### API
|
### API
|
||||||
|
|
||||||
Kapow! server interacts with the outside world only through its HTTP API. Any
|
Kapow! server interacts with the outside world only through its HTTP API. Any
|
||||||
@@ -114,6 +126,7 @@ whole lifetime of the server.
|
|||||||
|
|
||||||
## Design Principles
|
## Design Principles
|
||||||
|
|
||||||
|
* We reuse conventions of well-established software projects, such as Docker.
|
||||||
* All requests and responses will leverage JSON as the data encoding method.
|
* All requests and responses will leverage JSON as the data encoding method.
|
||||||
* The API calls responses will have two distinct parts:
|
* The API calls responses will have two distinct parts:
|
||||||
* The HTTP status code (e.g., `400`, which is a bad request). The target
|
* The HTTP status code (e.g., `400`, which is a bad request). The target
|
||||||
@@ -601,7 +614,7 @@ and an argument to it, the *command*.
|
|||||||
To deregister a route you must provide a *route_id*.
|
To deregister a route you must provide a *route_id*.
|
||||||
|
|
||||||
**Notes**:
|
**Notes**:
|
||||||
* The entrypoint definition matches *Docker*'s.
|
* The entrypoint definition matches *Docker*'s shell form of it.
|
||||||
* The index matches the way *netfilter*'s `iptables` handles rule numbering.
|
* The index matches the way *netfilter*'s `iptables` handles rule numbering.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user