Skip to content
This repository was archived by the owner on Dec 23, 2022. It is now read-only.

Commit cf0bb5c

Browse files
committed
Fixed typos
1 parent 5ae4872 commit cf0bb5c

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/protocol/daemon-api.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The Daemon Api is the api that provides the communication between the Server and a Daemon.
44
All interactions are instantiated from the Server.
55
<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.
77

88
## Structure
99

@@ -13,15 +13,15 @@ Every enpoint follows the following schema: `<endpoint-collection>/<endpoint>`
1313

1414
| Name | Description |
1515
|------|-------------|
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. |
1818

1919
## Security
2020

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)
2222
<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.
2525

2626
## Request
2727

@@ -57,7 +57,7 @@ The daemon must respond with the following headers:
5757
Content-Type: application/json; charset=utf-8
5858
```
5959

60-
The status code is also pased to the frontend.
60+
The status code is also passed to the frontend.
6161

6262
### Body
6363

@@ -73,11 +73,11 @@ The daemon must respond with the following body:
7373

7474
## Endpoint Discovery
7575

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.
7878
<br>
7979
<br>
80-
The reponse looks like this:
80+
The response looks like this:
8181

8282
```json
8383
[
@@ -96,4 +96,4 @@ The reponse looks like this:
9696
]
9797
```
9898

99-
__The description is currently not used.__
99+
_The description is currently not used._

0 commit comments

Comments
 (0)