From bf312112169b0e099c6e2431795685de284e0052 Mon Sep 17 00:00:00 2001 From: Raoul Snyman Date: Wed, 16 Mar 2011 14:27:52 +0200 Subject: [PATCH] Fixed up the documentation. --- openlp/plugins/remotes/lib/httpserver.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 86c635eed..0d1e163eb 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -78,6 +78,12 @@ the remotes. ``last`` Load the last slide. + ``text`` + Fetches the text of the current song. The output is a JSON-encoded + dict which looks like this:: + + {"result": {"slides": ["...", "..."]}} + ``/api/service/{action}`` Perform ``{action}`` on the service manager (e.g. go live). Data is passed as a json-encoded ``data`` parameter. Valid actions are: @@ -95,7 +101,10 @@ the remotes. {"request": {"id": 1}} ``list`` - Request a list of items in the service. + Request a list of items in the service. Returns a list of items in the + current service in a JSON-encoded dict like this:: + + {"results": {"items": [{...}, {...}]}} """ import logging