Skip to content

Commit

Permalink
Update services/hub/README.md
Browse files Browse the repository at this point in the history
Co-authored-by: Martin <[email protected]>
  • Loading branch information
kobergj and mmattel authored Jan 11, 2023
1 parent 71a1475 commit 17fd256
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions services/hub/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@ 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
A client can use the `hub/sse` endpoint to subscribe to events. This will open a http(s) connection for the server to send events to subscribed clients. These events can inform clients about various changes on the server like: file uploads, shares, space memberships, etc.

## Available Events
For complete and up-to-date list of available events see `pkg/service/events.go`
For a complete and up-to-date list of available events see `/services/hub/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
Note that for the time being, the `hub` service only serves the `UploadReady` event which is emitted when postprocessing a file has finished and the file is available for user access.

0 comments on commit 17fd256

Please sign in to comment.