From 3b8fd5ff90ca530cb8870b13f26e73afe2d23bc7 Mon Sep 17 00:00:00 2001 From: Benjamin Frost Date: Sun, 19 May 2024 20:35:52 +0200 Subject: [PATCH] docs: add wait note --- DOCS.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/DOCS.md b/DOCS.md index 793614b..cb59587 100644 --- a/DOCS.md +++ b/DOCS.md @@ -10,9 +10,7 @@ The API provides an endpoint to subscribe to events. 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. -!!! note - - For the initial request, it is possible to pass the query parameter `wait=false` to get the current event immediately. +> Note: For the initial request, it is possible to pass the query parameter `?wait=false` to get the current event immediately. ``` GET /events/:id/subscribe