Browse Source

jsonrpc-s Update docs

JSON-RPC is called JSON-RPC with a hyphen.
Olle E. Johansson 11 years ago
parent
commit
615b79edaf
2 changed files with 19 additions and 17 deletions
  1. 10 9
      modules/jsonrpc-s/README
  2. 9 8
      modules/jsonrpc-s/doc/jsonrpc-s_admin.xml

+ 10 - 9
modules/jsonrpc-s/README

@@ -67,8 +67,9 @@ Chapter 1. Admin Guide
 
 
    1.1. Limitations
    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.
    The JSONRPC-S module uses the xHTTP module to handle HTTP requests.
    Read the documentation of the xHTTP module for more details.
    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
      * This module does not implement asynchronous RPC commands. It is
        unlikely that asynchronous RPC commands will be executed from an
        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
      * 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
 2. Dependencies
 
 
@@ -104,7 +105,7 @@ Chapter 1. Admin Guide
 
 
 3.1. pretty_format (int)
 3.1. pretty_format (int)
 
 
-   Pretty format for JSONRPC response document.
+   Pretty format for JSON-RPC response document.
 
 
    Default value is '0'.
    Default value is '0'.
 
 
@@ -167,11 +168,11 @@ event_route[xhttp:request] {
 
 
 4.2. jsonrpc_exec(cmd)
 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
    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
    Example 1.3. jsonrpc_exec usage
 ...
 ...

+ 9 - 8
modules/jsonrpc-s/doc/jsonrpc-s_admin.xml

@@ -16,8 +16,9 @@
 	<section>
 	<section>
 	<title>Overview</title>
 	<title>Overview</title>
 	<para>
 	<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>
 	</para>
 	</para>
 		The JSONRPC-S module uses the xHTTP module to handle HTTP requests.
 		The JSONRPC-S module uses the xHTTP module to handle HTTP requests.
@@ -31,13 +32,13 @@
 	<para>
 	<para>
 		This module does not implement asynchronous RPC commands.
 		This module does not implement asynchronous RPC commands.
 		It is unlikely that asynchronous RPC commands will be executed
 		It is unlikely that asynchronous RPC commands will be executed
-		from an JSONRPC over HTTP client.
+		from an JSON-RPC over HTTP client.
 	</para>
 	</para>
 	</listitem>
 	</listitem>
 	<listitem>
 	<listitem>
 	<para>
 	<para>
 		This module does not accept parameters embedded in a structure
 		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).
 		passed to RPC).
 	</para>
 	</para>
 	</listitem>
 	</listitem>
@@ -80,7 +81,7 @@
 	<section>
 	<section>
 		<title><varname>pretty_format</varname> (int)</title>
 		<title><varname>pretty_format</varname> (int)</title>
 		<para>
 		<para>
-			Pretty format for JSONRPC response document. 
+			Pretty format for JSON-RPC response document. 
 		</para>
 		</para>
 		<para>
 		<para>
 		<emphasis>
 		<emphasis>
@@ -159,12 +160,12 @@ event_route[xhttp:request] {
 		<function moreinfo="none">jsonrpc_exec(cmd)</function>
 		<function moreinfo="none">jsonrpc_exec(cmd)</function>
 	    </title>
 	    </title>
 	    <para>
 	    <para>
-			Execute JSONRPC command given as parameter.
+			Execute a JSON-RPC command given as a parameter.
 		</para>
 		</para>
 		<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
 			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>
 	    </para>
 		<example>
 		<example>
 		<title><function>jsonrpc_exec</function> usage</title>
 		<title><function>jsonrpc_exec</function> usage</title>