Skip to content

Commit 3b8fd5f

Browse files
docs: add wait note
1 parent 2d0c0e2 commit 3b8fd5f

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

DOCS.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ The API provides an endpoint to subscribe to events.
1010

1111
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.
1212

13-
!!! note
14-
15-
For the initial request, it is possible to pass the query parameter `wait=false` to get the current event immediately.
13+
> Note: For the initial request, it is possible to pass the query parameter `?wait=false` to get the current event immediately.
1614
1715
```
1816
GET /events/:id/subscribe

0 commit comments

Comments
 (0)