From 741d4498f76f743df42a7dfa7906700e9c754658 Mon Sep 17 00:00:00 2001
From: Jonathan Weth <git@jonathanweth.de>
Date: Tue, 21 Jul 2020 17:39:59 +0200
Subject: Add trigger option and API methods for updating and getting session
 status

---
 API.rst | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

(limited to 'API.rst')

diff --git a/API.rst b/API.rst
index d9b2698..34960f5 100644
--- a/API.rst
+++ b/API.rst
@@ -26,6 +26,34 @@ Start a new remote session and register it in RWA
     {"id": <pid>, "url": "<url>", "pin": <pin>}
 
 
+status
+^^^^^^
+Return the status of a session
+
+.. note::
+
+    This uses the last status version got by the update service in the background.
+
+**Arguments:** pid/id (integer)
+
+**Return type:** string (JSON)
+
+
+**Structure of returned JSON:**
+
+::
+
+    {"id": <pid>, "status": <status>}
+
+**Possible status options:**
+
+- ``running``: The session is running and ready for connecting.
+- ``joined``: The session is running and a the remote connected to the session.
+
+refresh_status
+^^^^^^^^^^^^^^
+Same as ``status``, but updates status from Django before returning it here.
+
 stop
 ^^^^
 Stop a remote session
-- 
cgit v1.2.3