apunkt/trustgraph
1
0
Fork 0
mirror of https://github.com/trustgraph-ai/trustgraph.git synced 2026-07-17 17:21:02 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

More API doc hacking

Browse source
This commit is contained in:
Cyber MacGeddon 2024-12-28 15:14:45 +00:00
parent 779c62d328
commit 4b699159fe
7 changed files with 50 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/apis/websocket.md
View file

@ -6,10 +6,11 @@ The websocket service is provided by the `api-gateway` service on port
## URL
Depending on how the service is hosted, the websocket is invoked on URL:
Depending on how the service is hosted, the websocket is invoked on this
URL on `api-gateway`:
```
ws://api-gateway:8088/api/v1/socket
/api/v1/socket
```
When hosted using docker compose, you can access the service at
@ -22,7 +23,8 @@ A request message is a JSON message containing 3 fields:
- `id`: A unique ID which is used to correlate requests and responses.
You should make sure it is unique.
- `service`: The name of the service to invoke.
- `request`: The request body which is passed to the service.
- `request`: The request body which is passed to the service - this is
defined in the API documentation for that service.
e.g.