Skip to content

Commit 804a1fc

Browse files
authored
Merge pull request #82 from geotribu/doc/update-readme-swagger-links
doc(readme): update swagger doc links
2 parents a9308dd + f5fe208 commit 804a1fc

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ Following instances are up and running :
3535

3636
## Developer information
3737

38-
- Channel can be fetched using [the `/channels` endpoint](https://gischat.geotribu.net/docs#/default/get_channels_channels_get)
39-
- Rules can be fetched using [the `/rules` endpoint](https://gischat.geotribu.net/docs#/default/get_rules_rules_get)
40-
- Number of connected users can be fetched using [the `/status` endpoint](https://gischat.geotribu.net/docs#/default/get_status_status_get)
41-
- List of connected and registered users can be fetched using [the `/channel/{channel}/users` endpoint](https://gischat.geotribu.net/docs)
38+
- Channel can be fetched using [the `/channels` endpoint](https://qchat.geotribu.net/docs#/default/get_channels_channels_get)
39+
- Rules can be fetched using [the `/rules` endpoint](https://qchat.geotribu.net/docs#/default/get_rules_rules_get)
40+
- Number of connected users can be fetched using [the `/status` endpoint](https://qchat.geotribu.net/docs#/default/get_status_status_get)
41+
- List of connected and registered users can be fetched using [the `/channel/{channel}/users` endpoint](https://qchat.geotribu.net/docs#/default/get_connected_users_channel__channel__users_get)
4242
- New users must connect a websocket to the `/channel/{channel}/ws` endpoint
4343
- After connecting to the websocket, it is possible to register the user in the channel by sending a `newcomer` message (see below)
4444
- Messages passing through the websocket are strings with a JSON structure, they have a `type` key which represent which kind of message it is
@@ -211,7 +211,7 @@ Each of them has a `"type"` key based on which it is possible to parse them :
211211
212212
## Deploy a self-hosted instance
213213

214-
### Setup Gischat backend
214+
### Setup a gischat backend
215215

216216
> [!NOTE]
217217
> `NB_UVICORN_WORKERS` refers to the number of async workers. A usual convenient value would be : (nb_cpu * 2) + 1.

0 commit comments

Comments
 (0)