You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 23, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: docs/protocol/daemon-api.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
The Daemon Api is the api that provides the communication between the Server and a Daemon.
4
4
All interactions are instantiated from the Server.
5
5
<br>
6
-
This api is used to provide the frontend cabability to instantiate game processes.
6
+
This api is used to provide the frontend capability to instantiate game processes.
7
7
8
8
## Structure
9
9
@@ -13,15 +13,15 @@ Every enpoint follows the following schema: `<endpoint-collection>/<endpoint>`
13
13
14
14
| Name | Description |
15
15
|------|-------------|
16
-
| Endpoint Collection | As the name says, a endpoint collection is a collection of endpoints. All endpoints from a collection are from the same daemon. The pupuse of a endpoint collection is to group certan enpoints. (e.g. `network` contains all endpoints related to networks) |
17
-
| Endpoint | A endpoint is like a funtion on a daemon witch can be executed by the frontend. Mostly it changes database stated or sends notifications to other users. |
16
+
| Endpoint Collection | As the name says, a endpoint collection is a collection of endpoints. All endpoints from a collection are from the same daemon. The purpose of a endpoint collection is to group certain endpoints. (e.g. `network` contains all endpoints related to networks) |
17
+
| Endpoint | A endpoint is like a function on a daemon witch can be executed by the frontend. Mostly it changes database stated or sends notifications to other users. |
18
18
19
19
## Security
20
20
21
-
In normal cases all daemons are not public accessable. (e.g. secured by a firewall or Docker Networks)
21
+
In normal cases all daemons are not public accessible. (e.g. secured by a firewall or Docker Networks)
22
22
<br>
23
-
Altrough all request must contain an api token. The api token can be configured with an environment variable on the server and dameon side.
24
-
It is recommended to change the api token is requrlary time spans.
23
+
Although all request must contain an api token. The api token can be configured with an environment variable on the server and Dameon side.
24
+
It is recommended to change the api token is regular time spans.
25
25
26
26
## Request
27
27
@@ -57,7 +57,7 @@ The daemon must respond with the following headers:
57
57
Content-Type: application/json; charset=utf-8
58
58
```
59
59
60
-
The status code is also pased to the frontend.
60
+
The status code is also passed to the frontend.
61
61
62
62
### Body
63
63
@@ -73,11 +73,11 @@ The daemon must respond with the following body:
73
73
74
74
## Endpoint Discovery
75
75
76
-
When a server boots, it discovers all existing endpoints. Therefor it executes the discorvery endpoint for every dameon type.
77
-
This is needed to filter out request for non-existing endpoints and to route reponses to the daemon according to the endpoint.
76
+
When a server boots, it discovers all existing endpoints. Therefore, it executes the discovery endpoint for every Dameon type.
77
+
This is needed to filter out request for non-existing endpoints and to route requests to the daemon according to the endpoint.
0 commit comments