File tree Expand file tree Collapse file tree 1 file changed +10
-2
lines changed
Expand file tree Collapse file tree 1 file changed +10
-2
lines changed Original file line number Diff line number Diff line change @@ -19,8 +19,15 @@ the event-streaming service of the Squonk2 AS platform and is deployed to the
1919Namespace of the AS to service internal requests from the API to create, delete
2020and connect to the internal messaging bus to stream events to a client.
2121
22- The implementation is based on Python and the [ FastAPI] framework, offering an
23- _ internal_ API for use by the AS and a _ public_ web-socket API for clients to connect to.
22+ The implementation is based on Python and the [ FastAPI] framework, offering
23+ _ public_ web-sockets managed by an _ internal_ API, managed by the AS using
24+ the required endpoint: -
25+
26+ /event-stream POST
27+ /event-stream/{id} DELETE
28+
29+ See the AS Event Stream API documentation for more details, and the discussion
30+ of the [ Event Streams] service on its internal wiki.
2431
2532## Contributing
2633The project uses: -
@@ -67,6 +74,7 @@ request: -
6774[ black ] : https://black.readthedocs.io/en/stable
6875[ commitizen ] : https://commitizen-tools.github.io/commitizen/
6976[ conventional commit ] : https://www.conventionalcommits.org/en/v1.0.0/
77+ [ event streams ] : https://gitlab.com/informaticsmatters/squonk2-account-server/-/wikis/event-streams
7078[ fastapi ] : https://fastapi.tiangolo.com
7179[ pre-commit ] : https://pre-commit.com
7280[ poetry ] : https://python-poetry.org/
You can’t perform that action at this time.
0 commit comments