From c1b88b5944156a7b5e7f34abe735047cff7092d7 Mon Sep 17 00:00:00 2001 From: Jonathan Weth Date: Wed, 29 Jul 2020 17:49:15 +0200 Subject: Remove legacy API documentation --- API.rst | 69 ----------------------------------------------------------------- 1 file changed, 69 deletions(-) delete mode 100644 API.rst diff --git a/API.rst b/API.rst deleted file mode 100644 index 9cec20b..0000000 --- a/API.rst +++ /dev/null @@ -1,69 +0,0 @@ -API documentation for Session Service -===================================== - -General information -------------------- - -Bus name: ``org.ArcticaProject.RWA`` - -Object name: ``/RWA`` - -Methods -------- - -start -^^^^^ -Start a new remote session and register it in RWA - -**Arguments:** none - -**Return type:** string (JSON) - -**Structure of returned JSON (success):** - -:: - - {"status": "success", "id": , "url": "", "pin": } - -**Structure of returned JSON (error):** - -:: - - {"status": "error"} - - -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": , "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 - -**Arguments:** pid/id (integer) - -**Return type:** none -- cgit v1.2.3