Skip to content

Commit 5c68370

Browse files
docs: clean up
1 parent 3b8fd5f commit 5c68370

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

DOCS.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ This is the API documentation for the AEC 2024 Skill 08 Session 4 API.
44

55
## Events
66

7-
The API provides an endpoint to subscribe to events.
7+
The API provides an endpoint to subscribe to the actions of an event.
88

99
### Subscribe to an Event
1010

11-
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.
11+
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.
1212

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

1515
```
1616
GET /events/:id/subscribe

0 commit comments

Comments
 (0)