[sr-dev] git:master:369f79b8: curl Fix documentation, remove local character

Module: kamailio Branch: master Commit: 369f79b8a1f24dacb52634fc13530fd42c921898 URL: https://github.com/kamailio/kamailio/commit/369f79b8a1f24dacb52634fc13530fd… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: 2015-10-02T08:23:26+03:00 curl Fix documentation, remove local character --- Modified: modules/curl/README Modified: modules/curl/doc/curl_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/369f79b8a1f24dacb52634fc13530fd… Patch: https://github.com/kamailio/kamailio/commit/369f79b8a1f24dacb52634fc13530fd… --- diff --git a/modules/curl/README b/modules/curl/README index 1ce4575..b75df17 100644 --- a/modules/curl/README +++ b/modules/curl/README @@ -119,6 +119,9 @@ Chapter 1. Admin Guide 1. Overview + Note: This module is still in development. Not all options documented + here work yet. + This module implements protocol functions that use the libcurl library to fetch data from external HTTP servers or post data to HTTP servers. The module is using a concept of "connections" to define properties of @@ -303,12 +306,13 @@ content_type, data, result) Example 1.9. curl_connect() usage ... -modparam("curl", "curlcon", "anders=>http://kamailio.org/api/"); +modparam("curl", "curlcon", "apiserver=>http://kamailio.org/api/"); ... # POST Request -$var(res) = curl_connect("apiserver", "/postlåda", "application/json", "{ ok, { -200, ok}}", "$avp(gurka)"); -xlog("L_INFO", "API-server Curl connection: $avp(gurka) Result $var(res)\n"); +$var(res) = curl_connect("apiserver", "/mailbox", "application/json", "{ ok, {20 +0, ok}}", "$avp(gurka)"); +xlog("L_INFO", "API-server Curl connection: $avp(gurka) Result code $var(res)\n" +); ... 4.2. curl_http_query(url, [post-data], result) diff --git a/modules/curl/doc/curl_admin.xml b/modules/curl/doc/curl_admin.xml index 3bd7c31..1639b86 100644 --- a/modules/curl/doc/curl_admin.xml +++ b/modules/curl/doc/curl_admin.xml @@ -16,6 +16,10 @@ <section> <title>Overview</title> <para> + Note: This module is still in development. Not all options documented + here work yet. + </para> + <para> This module implements protocol functions that use the libcurl library to fetch data from external HTTP servers or post data to HTTP servers. The module is using a concept of "connections" to define properties @@ -286,11 +290,11 @@ modparam("curl", "curlcon", "apifour=>http://stockholm.example.com/api/getstuff; <title><function>curl_connect()</function> usage</title> <programlisting format="linespecific"> ... -modparam("curl", "curlcon", "anders=>http://kamailio.org/api/"); +modparam("curl", "curlcon", "apiserver=>http://kamailio.org/api/"); ... # POST Request -$var(res) = curl_connect("apiserver", "/postlåda", "application/json", "{ ok, {200, ok}}", "$avp(gurka)"); -xlog("L_INFO", "API-server Curl connection: $avp(gurka) Result $var(res)\n"); +$var(res) = curl_connect("apiserver", "/mailbox", "application/json", "{ ok, {200, ok}}", "$avp(gurka)"); +xlog("L_INFO", "API-server Curl connection: $avp(gurka) Result code $var(res)\n"); ... </programlisting> </example>