From 4eb1dc6b06867a1f1906fa32ab6448d0a00b9700 Mon Sep 17 00:00:00 2001 From: Jonathan Weth Date: Tue, 21 Jul 2020 16:39:51 +0200 Subject: Add API documentation for service --- API.rst | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 API.rst 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": , "url": "", "pin": } + + +stop +^^^^ +Stop a remote session + +**Arguments:** pid/id (integer) + +**Return type:** none -- cgit v1.2.3