curl Update documentation with a note about URL encoding

kamailio · Nov 3, 2015 · c54d6ab · c54d6ab
1 parent 1faef12
commit c54d6ab
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/modules/curl/README b/modules/curl/README
@@ -132,9 +132,13 @@ Chapter 1. Admin Guide
    and much more either using modparam settings or parameters to the
    connection definition.
 
-   Function http_query allows Kamailio to issue an HTTP GET request and
-   get access to parts of the reply. This function has been ported from
-   the utils module and now use the same libcurl functions.
+   Like in SIP, the HTTP URL may need encoding to be transported safely
+   over the network. Check the string encoding functions in the
+   Transformation Cookbook (as used in the curl_http_query example below).
+
+   Function curl_http_query allows Kamailio to issue an HTTP GET request
+   and get access to parts of the reply. This function has been ported
+   from the utils module and now use the same libcurl functions.
 
 2. Dependencies
 

diff --git a/modules/curl/doc/curl_admin.xml b/modules/curl/doc/curl_admin.xml
@@ -32,7 +32,12 @@
 	connection definition.
 	</para>
 	<para>
-	Function http_query allows &kamailio; to issue an HTTP GET
+	Like in SIP, the HTTP URL may need encoding to be transported safely
+	over the network. Check the string encoding functions in the Transformation
+	Cookbook (as used in the curl_http_query example below).
+	</para>
+	<para>
+	Function curl_http_query allows &kamailio; to issue an HTTP GET
 	request and get access to parts of the reply. This function has
 	been ported from the utils module and now use the same libcurl
 	functions.