From 3d3720875c019d7ac6ae8e69f9a2bbc8bcb73f71 Mon Sep 17 00:00:00 2001 From: jkoberg Date: Tue, 10 Jan 2023 14:55:35 +0100 Subject: [PATCH] add a README for the hub service Signed-off-by: jkoberg --- services/hub/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 services/hub/README.md diff --git a/services/hub/README.md b/services/hub/README.md new file mode 100644 index 00000000000..33ba3c6680d --- /dev/null +++ b/services/hub/README.md @@ -0,0 +1,14 @@ +# Hub Service + +The hub service provides `server sent events` (`sse`) functionality to clients + +## Subscribing + +A client can use the `hub/sse` endpoint to subscribe to events. It will open an http connection for the server to send events. +These events can inform the client about different changes on the server, for example: file uploads, shares, space memberships, ... +See `Available Events` for details + +## Available Events +For complete and up-to-date list of available events see `pkg/service/events.go` + +For starters the `hub` service only serves the `UploadReady` event which is emitted when a files postprocessing is finished and the file is ready to work with