Add description about "streaming health" endpoint

This commit is contained in:
kjwon15 2019-06-03 16:20:36 +09:00
parent fc3a976a04
commit 54e99c894d
1 changed files with 4 additions and 0 deletions

View File

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