Skip to content

Commit

Permalink
Align docs to latest changes in module functions parameters
Browse files Browse the repository at this point in the history 
(cherry picked from commit e456ddd)
  • Loading branch information
@rvlad-patrascu
rvlad-patrascu committed Apr 25, 2019
1 parent 9642dce commit e9ea1fa
Show file tree
Hide file tree
Showing 72 changed files with 1,290 additions and 1,216 deletions.
58 changes: 33 additions & 25 deletions modules/aaa_radius/doc/aaa_radius_admin.xml
View file
Expand Up @@ -224,17 +224,21 @@ modparam("aaa_radius", "fetch_all_values", 1)
This function can be used from the script to make custom
radius authentication request. The function takes two parameters.
</para>
<para>
The first parameter represents the name of the set that contains
the list of attributes and pvars that will form the authentication
request (see the <quote>sets</quote> module parameter).
</para>
<para>
The second parameter represents the name of the set that contains
the list of attributes and pvars that will be extracted form the
authentication reply (see the <quote>sets</quote> module
parameter).
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>input_set_name</emphasis> (string) - the name of the
set that contains the list of attributes and pvars that will
form the authentication request (see the <quote>sets</quote>
module parameter).
</para></listitem>
<listitem><para>
<emphasis>output_set_name</emphasis> (string) - the name of the
set that contains the list of attributes and pvars that will be
extracted form the authentication reply (see the <quote>sets</quote>
module parameter).
</para></listitem>
</itemizedlist>
<para>
The sets must be defined using the <quote>sets</quote> exported
parameter.
Expand Down Expand Up @@ -277,7 +281,7 @@ switch ($rc) {
</title>
<para>
This function can be used from the script to make custom
radius authentication request. The function takes only one parameter
radius authentication request. The function takes only one string parameter
that represents the name of the set that contains the list of attributes
and pvars that will form the accounting request.
</para>
Expand Down Expand Up @@ -315,19 +319,23 @@ radius_send_acct("set1");
</title>
<para>
This function can be used from the script to make custom
radius authentication request. The function takes two parameters.
</para>
<para>
The first parameter represents the name of the set that contains
the list of attributes and pvars that will form the authentication
request (see the <quote>sets</quote> module parameter).
</para>
<para>
The second parameter represents the name of the set that contains
the list of attributes and pvars that will be extracted form the
authentication reply (see the <quote>sets</quote> module
parameter).
radius authentication request.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>input_set_name</emphasis> (string) - the name of the
set that contains the list of attributes and pvars that will
form the authentication request (see the <quote>sets</quote>
module parameter).
</para></listitem>
<listitem><para>
<emphasis>output_set_name</emphasis> (string) - the name of the
set that contains the list of attributes and pvars that will be
extracted form the authentication reply (see the <quote>sets</quote>
module parameter).
</para></listitem>
</itemizedlist>
<para>
The sets must be defined using the <quote>sets</quote> exported
parameter.
Expand Down Expand Up @@ -371,7 +379,7 @@ switch ($rc) {
</title>
<para>
This function can be used from the script to make custom
radius authentication request. The function takes only one parameter
radius authentication request. The function takes only one string parameter
that represents the name of the set that contains the list of attributes
and pvars that will form the accounting request.
</para>
Expand Down
36 changes: 12 additions & 24 deletions modules/auth/doc/auth_admin.xml
View file
Expand Up @@ -290,7 +290,7 @@ modparam("auth", "disable_nonce_check", 1)
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>realm</emphasis> - Realm is an opaque string that
<para><emphasis>realm</emphasis> (string) - Realm is an opaque string that
the user agent should present to the user so it can decide what
username and password to use. Usually this is domain of the host
the server is running on.
Expand All @@ -302,12 +302,9 @@ modparam("auth", "disable_nonce_check", 1)
represents a user being registered), for all other messages From
header field domain will be used.
</para>
<para>
The string may contain pseudo variables.
</para>
</listitem>
<listitem>
<para><emphasis>qop</emphasis> - Value of this parameter can be
<para><emphasis>qop</emphasis> (int) - Value of this parameter can be
either <quote>1</quote> or <quote>0</quote>. When set to 1 then
the server will put a qop parameter in the challenge. When set to 0
then the server will not put the qop parameter in the challenge. It
Expand All @@ -332,7 +329,7 @@ modparam("auth", "disable_nonce_check", 1)
<programlisting format="linespecific">
...
if (!www_authorize("siphub.net", "subscriber")) {
www_challenge("siphub.net", "1");
www_challenge("siphub.net", 1);
};
...
</programlisting>
Expand All @@ -354,7 +351,7 @@ if (!www_authorize("siphub.net", "subscriber")) {
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>realm</emphasis> - Realm is an opaque string that
<para><emphasis>realm</emphasis> (string) - Realm is an opaque string that
the user agent should present to the user so it can decide what
username and password to use. Usually this is domain of the host
the server is running on.
Expand All @@ -364,12 +361,9 @@ if (!www_authorize("siphub.net", "subscriber")) {
generate it from the request. <quote>From</quote> header field domain will be
used as realm.
</para>
<para>
The string may contain pseudo variables.
</para>
</listitem>
<listitem>
<para><emphasis>qop</emphasis> - Value of this parameter can be
<para><emphasis>qop</emphasis> (int) - Value of this parameter can be
either <quote>1</quote> or <quote>0</quote>. When set to 1 then
the server will put a qop parameter in the challenge. When set to 0
then the server will not put the qop parameter in the challenge. It
Expand All @@ -393,7 +387,7 @@ if (!www_authorize("siphub.net", "subscriber")) {
<programlisting format="linespecific">
...
if (!proxy_authorize("", "subscriber)) {
proxy_challenge("", "1"); # Realm will be autogenerated
proxy_challenge("", 1); # Realm will be autogenerated
};
...
</programlisting>
Expand Down Expand Up @@ -490,13 +484,13 @@ append_rpid_hf(); # Append Remote-Party-ID header field
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>prefix</emphasis> - Prefix of the
<para><emphasis>prefix</emphasis> (string) - Prefix of the
Remote-Party-ID URI. The string will be added at the beginning of
body of the header field, just before the URI.
</para>
</listitem>
<listitem>
<para><emphasis>suffix</emphasis> - Suffix of the Remote-Party-ID
<para><emphasis>suffix</emphasis> (string) - Suffix of the Remote-Party-ID
header field. The string will be appended at the end of the
header field. It can be used to set various URI parameters,
for example.
Expand Down Expand Up @@ -556,7 +550,7 @@ append_rpid_hf("", ";party=calling;id-type=subscriber;screen=yes");
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>realm</emphasis> - Realm is an opaque string that
<para><emphasis>realm</emphasis> (string) - Realm is an opaque string that
the user agent should present to the user so he can decide what
username and password to use. Usually this is domain of the host
the server is running on.
Expand All @@ -568,9 +562,6 @@ append_rpid_hf("", ";party=calling;id-type=subscriber;screen=yes");
represents a user being registered), for all other messages From
header field domain will be used.
</para>
<para>
The string may contain pseudo variables.
</para>
</listitem>
</itemizedlist>
<para>
Expand All @@ -584,7 +575,7 @@ append_rpid_hf("", ";party=calling;id-type=subscriber;screen=yes");
$var(username)="abc";
$avp(password)="xyz";
if (!pv_www_authorize("opensips.org")) {
www_challenge("opensips.org", "1");
www_challenge("opensips.org", 1);
};
...
</programlisting>
Expand All @@ -610,7 +601,7 @@ if (!pv_www_authorize("opensips.org")) {
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>realm</emphasis> - Realm is an opaque string that
<para><emphasis>realm</emphasis> (string) - Realm is an opaque string that
the user agent should present to the user so he can decide what
username and password to use. Usually this is domain of the host
the server is running on.
Expand All @@ -620,9 +611,6 @@ if (!pv_www_authorize("opensips.org")) {
generate it from the request. From header field domain will be
used as realm.
</para>
<para>
The string may contain pseudo variables.
</para>
</listitem>
</itemizedlist>
<para>
Expand All @@ -635,7 +623,7 @@ if (!pv_www_authorize("opensips.org")) {
$var(username)="abc";
$avp(password)="xyz";
if (!pv_proxy_authorize("")) {
proxy_challenge("", "1"); # Realm will be autogenerated
proxy_challenge("", 1); # Realm will be autogenerated
};
...
</programlisting>
Expand Down
46 changes: 31 additions & 15 deletions modules/b2b_logic/doc/b2b_logic_admin.xml
View file
Expand Up @@ -432,7 +432,8 @@ modparam("b2b_logic", "b2bl_th_init_timeout", 60)
<title>Exported Functions</title>
<section id="func_b2b_init_request" xreflabel="b2b_init_request()">
<title>
<function moreinfo="none">b2b_init_request()</function>
<function moreinfo="none">b2b_init_request(flags, [scenario_param1],
[scenario_param2], [scenario_param3], [scenario_param4])</function>
</title>
<para>
This is the function that must be called by the script writer
Expand All @@ -445,26 +446,41 @@ modparam("b2b_logic", "b2bl_th_init_timeout", 60)
This is defined in the XML document as an attribute of the root node
or "top hiding" for internal topology hiding scenario.
It can be passed as "scenario" or "scenario_name/flags".
Then it can take at most 4 other parameters that represent the parameters for
the xml scenario. The expected number of parameters is also specified as an attribute
in the root node of the XML scenario.
</para>
<para>Meaning of the flags is as follows:</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>t[nn]</emphasis> - Call setup timeout for topology hiding scenario.
Example: t300.
<emphasis>flags (string)</emphasis> - meaning of the flags is as follows:
<itemizedlist>
<listitem><para>
<emphasis>t[nn]</emphasis> - Call setup timeout for topology hiding scenario.
Example: t300.
</para></listitem>
<listitem><para>
<emphasis>a</emphasis> - Transparent authentication. In this mode b2b passes your 401
or 407 authentication request to destination server.
</para></listitem>
<listitem><para>
<emphasis>p</emphasis> - Preserve To: header.
</para></listitem>
</itemizedlist>
</para></listitem>
<listitem><para>
<emphasis>scenario_param1 (string, optional)</emphasis>
</para></listitem>
<listitem><para>
<emphasis>a</emphasis> - Transparent authentication. In this mode b2b passes your 401
or 407 authentication request to destination server.
<emphasis>scenario_param2 (string, optional)</emphasis>
</para></listitem>
<listitem><para>
<emphasis>p</emphasis> - Preserve To: header.
<emphasis>scenario_param3 (string, optional)</emphasis>
</para></listitem>
<listitem><para>
<emphasis>scenario_param4 (string, optional)</emphasis>
</para></listitem>
</itemizedlist>
<para>
Then it can take at most 4 other parameters that represent the parameters for
the xml scenario. The expected number of parameters is also specified as an attribute
in the root node of the XML scenario.
</para>
<note><para>
If you have a multi interface setup and want to chance the outbound interface,
it is mandatory to use the "force_send_socket()" core function before passing
Expand Down Expand Up @@ -493,12 +509,12 @@ if(is_method("INVITE") &amp;&amp; !has_totag() &amp;&amp; prepaid_user())
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>b2bl_key</emphasis> - a pseudo-variable that
<emphasis>b2bl_key (string)</emphasis> - a string that
contains the b2b_logic key. The key can also be in the form
of <emphasis>callid;from-tag;to-tag</emphasis>.
</para></listitem>
<listitem><para>
<emphasis>entity_no</emphasis> - a pseudo-variable that
<emphasis>entity_no (int)</emphasis> - an integer that
holds the entity of the entity/participant to bridge.
</para></listitem>
</itemizedlist>
Expand All @@ -517,7 +533,7 @@ route[b2b_request]
# the Call-ID carries the B2B key ID
if (is_method("BYE") {
$var(entity) = 1;
b2b_bridge_request("$ci","$var(entity)");
b2b_bridge_request($ci,$var(entity));
}
}
...
Expand Down
12 changes: 6 additions & 6 deletions modules/b2b_sca/doc/b2b_sca_admin.xml
View file
Expand Up @@ -431,7 +431,7 @@ modparam("b2b_sca", "app2_b2bl_key_column", "second_b2bl_key")
</para>
<para>Meaning of the parameters:</para>
<itemizedlist>
<listitem><para><emphasis>shared_line</emphasis> - a PV (pseudo-variable)
<listitem><para><emphasis>shared_line</emphasis> (int) - an integer
identifying the call leg as being an "appearnace" call or a "shared" call:
<itemizedlist>
<listitem><para>0: "shared" call</para></listitem>
Expand Down Expand Up @@ -474,8 +474,8 @@ modparam("b2b_sca",
}

# Initiate the call
if (!sca_init_request("$var(shared_line_entity)")) {
send_reply("403", "Internal Server Error (SLA)");
if (!sca_init_request($var(shared_line_entity))) {
send_reply(403, "Internal Server Error (SLA)");
exit;
}
...
Expand All @@ -492,7 +492,7 @@ modparam("b2b_sca",
</para>
<para>Meaning of the parameters:</para>
<itemizedlist>
<listitem><para><emphasis>shared_line_to_bridge</emphasis> - a PV identifying
<listitem><para><emphasis>shared_line_to_bridge</emphasis> (string) - a string identifying
the shared line/call that was previously set by sca_init_request().
</para>
</listitem>
Expand All @@ -504,8 +504,8 @@ modparam("b2b_sca",
# The incoming call is an 'appearance' call
# - see Alice's call from alice2 in the given example
$var(shared_line_to_bridge) = "alice";
if (!sca_bridge_request("$var(shared_line_to_bridge)"))
send_reply("403", "Internal SLA Error");
if (!sca_bridge_request($var(shared_line_to_bridge)))
send_reply(403, "Internal SLA Error");
exit;
}
}
Expand Down
9 changes: 9 additions & 0 deletions modules/cachedb_local/doc/cachedb_local_admin.xml
View file
Expand Up @@ -248,6 +248,15 @@ modparam("cachedb_local", "cluster_persistency", "sync-from-cluster")
if none defined. Keep in mind that collection name is different than group name,
which identifies the engine in cachedb operations.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>collection</emphasis> (string, optional)
</para></listitem>
<listitem><para>
<emphasis>glob</emphasis> (string)
</para></listitem>
</itemizedlist>
<para>
This function can be used from all routes
</para>
Expand Down

0 comments on commit e9ea1fa

Please sign in to comment.