Skip to content

Commit

Permalink
docs: add note about short polling
Browse files Browse the repository at this point in the history
  • Loading branch information
Benjamin-Frost committed May 28, 2024
1 parent 36b74d1 commit 04f37fd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/s4-api-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The API provides endpoints to subscribe to the actions of an event and to send a

### Subscribe to an Event

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

```
GET /events/:id/subscribe
Expand Down Expand Up @@ -37,7 +37,7 @@ Example Responses

### Answer a Poll

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

```
POST /events/:id/vote
Expand Down

0 comments on commit 04f37fd

Please sign in to comment.