Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API for events #7

Open
6 tasks
thejhh opened this issue Jan 1, 2023 · 0 comments
Open
6 tasks

API for events #7

thejhh opened this issue Jan 1, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@thejhh
Copy link
Contributor

thejhh commented Jan 1, 2023

GET /api/v1/grid/:grid/events

Listen for events on the specified grid. This endpoint uses HTTP long polling,
so the connection will remain open until an event is triggered or a timeout is
reached. When an event is triggered, the server will send a response with the
details of the event, and the connection will close. The client can then make
another request to listen for further events.

This endpoint accepts the following query parameters:

  • timeout: The maximum duration, in seconds, to keep the connection open
    before timing out. The default is 30 seconds.
  • lastEventId: The ID of the last event received by the client. The server
    will only send events with a higher ID. If this parameter is not provided, the
    server will send all events.

TODO

  • Documentation
  • Unit tests
  • Implementation
  • Reference documentation
  • System tests
  • Tutorial
@thejhh thejhh added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant