Skip to content

Commit 1ba036a

Browse files
author
Alan Christie
committed
docs: Doc tweak
1 parent 00b7e2b commit 1ba036a

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,15 @@ the event-streaming service of the Squonk2 AS platform and is deployed to the
1919
Namespace of the AS to service internal requests from the API to create, delete
2020
and 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
2633
The 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/

0 commit comments

Comments
 (0)