Skip to content

Commit 04f37fd

Browse files
docs: add note about short polling
1 parent 36b74d1 commit 04f37fd

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/s4-api-docs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The API provides endpoints to subscribe to the actions of an event and to send a
88

99
### Subscribe to an Event
1010

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

1313
```
1414
GET /events/:id/subscribe
@@ -37,7 +37,7 @@ Example Responses
3737

3838
### Answer a Poll
3939

40-
This endpoint allows clients to answer a poll. The client should make a POST request to this endpoint with the answer in the request body.
40+
This endpoint allows clients to answer a poll. In contrast to the first endpoint, this one uses **HTTP Short Polling**. The client should make a POST request to this endpoint with the answer in the request body.
4141

4242
```
4343
POST /events/:id/vote

0 commit comments

Comments
 (0)