[sr-dev] git:master: jsonrpc-s Update docs

Module: sip-router Branch: master Commit: 615b79edafc990d2a82394c8b020fd7687dc7bc5 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=615b79e… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: Tue Sep 23 21:49:18 2014 +0200 jsonrpc-s Update docs JSON-RPC is called JSON-RPC with a hyphen. --- modules/jsonrpc-s/README | 19 ++++++++++--------- modules/jsonrpc-s/doc/jsonrpc-s_admin.xml | 17 +++++++++-------- 2 files changed, 19 insertions(+), 17 deletions(-) diff --git a/modules/jsonrpc-s/README b/modules/jsonrpc-s/README index c06769b..bb92a7a 100644 --- a/modules/jsonrpc-s/README +++ b/modules/jsonrpc-s/README @@ -67,8 +67,9 @@ Chapter 1. Admin Guide 1.1. Limitations - This module provides JSONRPC server over HTTP implementation, tailored - for the needs of Kamailio. + This module provides a JSON-RPC server over HTTP implementation, + tailored for the needs of Kamailio. It implements the Kamailio RPC + interface over JSON-RPC. The JSONRPC-S module uses the xHTTP module to handle HTTP requests. Read the documentation of the xHTTP module for more details. @@ -77,10 +78,10 @@ Chapter 1. Admin Guide * This module does not implement asynchronous RPC commands. It is unlikely that asynchronous RPC commands will be executed from an - JSONRPC over HTTP client. + JSON-RPC over HTTP client. * This module does not accept parameters embedded in a structure (see - RPC documentation for more info about how parameters can be passed - to RPC). + the RPC documentation for more info about how parameters can be + passed to RPC). 2. Dependencies @@ -104,7 +105,7 @@ Chapter 1. Admin Guide 3.1. pretty_format (int) - Pretty format for JSONRPC response document. + Pretty format for JSON-RPC response document. Default value is '0'. @@ -167,11 +168,11 @@ event_route[xhttp:request] { 4.2. jsonrpc_exec(cmd) - Execute JSONRPC command given as parameter. + Execute a JSON-RPC command given as a parameter. - The parameter has to be a full valid JSONRPC document. It can be a + The parameter has to be a valid full JSON-RPC document. It can be a dynamic string with variables. The result of the command can be - accessed via $jsonrpl(key) variables. + accessed via $jsonrpl(key) pseudo variables. Example 1.3. jsonrpc_exec usage ... diff --git a/modules/jsonrpc-s/doc/jsonrpc-s_admin.xml b/modules/jsonrpc-s/doc/jsonrpc-s_admin.xml index 77a0e3a..a12b153 100644 --- a/modules/jsonrpc-s/doc/jsonrpc-s_admin.xml +++ b/modules/jsonrpc-s/doc/jsonrpc-s_admin.xml @@ -16,8 +16,9 @@ <section> <title>Overview</title> <para> - This module provides JSONRPC server over HTTP implementation, - tailored for the needs of &kamailio;. + This module provides a JSON-RPC server over HTTP implementation, + tailored for the needs of &kamailio;. It implements the &kamailio; + RPC interface over JSON-RPC. <para> </para> The JSONRPC-S module uses the xHTTP module to handle HTTP requests. @@ -31,13 +32,13 @@ <para> This module does not implement asynchronous RPC commands. It is unlikely that asynchronous RPC commands will be executed - from an JSONRPC over HTTP client. + from an JSON-RPC over HTTP client. </para> </listitem> <listitem> <para> This module does not accept parameters embedded in a structure - (see RPC documentation for more info about how parameters can be + (see the RPC documentation for more info about how parameters can be passed to RPC). </para> </listitem> @@ -80,7 +81,7 @@ <section> <title><varname>pretty_format</varname> (int)</title> <para> - Pretty format for JSONRPC response document. + Pretty format for JSON-RPC response document. </para> <para> <emphasis> @@ -159,12 +160,12 @@ event_route[xhttp:request] { <function moreinfo="none">jsonrpc_exec(cmd)</function> </title> <para> - Execute JSONRPC command given as parameter. + Execute a JSON-RPC command given as a parameter. </para> <para> - The parameter has to be a full valid JSONRPC document. It can + The parameter has to be a valid full JSON-RPC document. It can be a dynamic string with variables. The result of the command - can be accessed via $jsonrpl(key) variables. + can be accessed via $jsonrpl(key) pseudo variables. </para> <example> <title><function>jsonrpc_exec</function> usage</title>