Skip to content

Commit

Permalink
docs: clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
Benjamin-Frost committed May 19, 2024
1 parent 3b8fd5f commit 5c68370
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ This is the API documentation for the AEC 2024 Skill 08 Session 4 API.

## Events

The API provides an endpoint to subscribe to events.
The API provides an endpoint to subscribe to the actions of an event.

### Subscribe to an Event

This endpoint uses HTTP Long Polling, meaning the connection will remain open until an event is available. Clients should make a request to this endpoint and wait for a response. Once a response is received, the client should immediately make another request to continue receiving events.
This endpoint uses HTTP Long Polling, meaning the connection will remain open until an action is available. Clients should make a request to this endpoint and wait for a response. Once a response is received, the client should immediately make another request to continue receiving actions.

> Note: For the initial request, it is possible to pass the query parameter `?wait=false` to get the current event immediately.
For the initial request, it is possible to pass the query parameter `wait=false` to get the current action immediately.

```
GET /events/:id/subscribe
Expand Down

0 comments on commit 5c68370

Please sign in to comment.