From 57352c83bd1ca20546cf9763b991f0e55d86e3c0 Mon Sep 17 00:00:00 2001 From: Johannes Fried Date: Tue, 29 Mar 2022 15:01:47 +0200 Subject: [PATCH] Add Shutdown API Documentation --- dev-docs/Client-Server API.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/dev-docs/Client-Server API.md b/dev-docs/Client-Server API.md index 3cb13a0..127b1fd 100644 --- a/dev-docs/Client-Server API.md +++ b/dev-docs/Client-Server API.md @@ -442,6 +442,16 @@ a ping message every minute: } ``` +## Shutdown + +To shutdown the server process, the client can send: + +```json +{ + "event": "shutdown" +} +``` + ## Old Ping API (NOT IMPLEMENTED) To ensure a good user experience, the server and client require a reliable and