From 54e99c894da9597a5785dfcc37151f656c389a5f Mon Sep 17 00:00:00 2001 From: kjwon15 Date: Mon, 3 Jun 2019 16:20:36 +0900 Subject: [PATCH] Add description about "streaming health" endpoint --- content/en/api/streaming.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/content/en/api/streaming.md b/content/en/api/streaming.md index 8faaa3d2..ebe2a3a4 100644 --- a/content/en/api/streaming.md +++ b/content/en/api/streaming.md @@ -13,6 +13,10 @@ Alternatively, a WebSocket connection can also be established. ## Server-sent events (HTTP) ### Endpoints +#### GET /api/v1/streaming/health + +Returns `OK` when streaming service is fine + #### GET /api/v1/streaming/user Returns events that are relevant to the authorized user, i.e. home timeline and notifications