aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Weth <git@jonathanweth.de>2020-07-21 16:39:51 +0200
committerJonathan Weth <git@jonathanweth.de>2020-07-21 16:39:51 +0200
commit4eb1dc6b06867a1f1906fa32ab6448d0a00b9700 (patch)
tree277af0c2e5269972fba47117ebc9a4c8c465520d
parent817b979ddfe49da8d0d4661ca714f598f06b4a47 (diff)
downloadRWA.Support.SessionService-4eb1dc6b06867a1f1906fa32ab6448d0a00b9700.tar.gz
RWA.Support.SessionService-4eb1dc6b06867a1f1906fa32ab6448d0a00b9700.tar.bz2
RWA.Support.SessionService-4eb1dc6b06867a1f1906fa32ab6448d0a00b9700.zip
Add API documentation for service
-rw-r--r--API.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/API.rst b/API.rst
new file mode 100644
index 0000000..d9b2698
--- /dev/null
+++ b/API.rst
@@ -0,0 +1,35 @@
+API documentation for Session Service
+=====================================
+
+General information
+-------------------
+
+Bus name: ``de.rwa.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:**
+
+::
+
+ {"id": <pid>, "url": "<url>", "pin": <pin>}
+
+
+stop
+^^^^
+Stop a remote session
+
+**Arguments:** pid/id (integer)
+
+**Return type:** none