From 5c68370ef1ad54e1c83a3e413363f1ddabd7c9b6 Mon Sep 17 00:00:00 2001 From: Benjamin Frost Date: Sun, 19 May 2024 20:39:57 +0200 Subject: [PATCH] docs: clean up --- DOCS.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/DOCS.md b/DOCS.md index cb59587..6c78f26 100644 --- a/DOCS.md +++ b/DOCS.md @@ -4,13 +4,13 @@ This is the API documentation for the AEC 2024 Skill 08 Session 4 API. ## Events -The API provides an endpoint to subscribe to events. +The API provides an endpoint to subscribe to the actions of an event. ### Subscribe to an Event -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. +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. -> Note: For the initial request, it is possible to pass the query parameter `?wait=false` to get the current event immediately. +For the initial request, it is possible to pass the query parameter `wait=false` to get the current action immediately. ``` GET /events/:id/subscribe