Module: kamailio
Branch: 5.8
Commit: 3161964efba19e5e7bd730bf656d019cac2c6ed8
URL: https://github.com/kamailio/kamailio/commit/3161964efba19e5e7bd730bf656d019…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2024-07-01T09:16:18+02:00
modules: readme files regenerated - modules ... [skip ci]
---
Modified: src/modules/textopsx/README
---
Diff: https://github.com/kamailio/kamailio/commit/3161964efba19e5e7bd730bf656d019…
Patch: https://github.com/kamailio/kamailio/commit/3161964efba19e5e7bd730bf656d019…
---
diff --git a/src/modules/textopsx/README b/src/modules/textopsx/README
index 1759870cb2f..3e2f9e2eb6b 100644
--- a/src/modules/textopsx/README
+++ b/src/modules/textopsx/README
@@ -731,27 +731,38 @@ bl_iterator_end("b1");
3.1. @hf_value
- Get value of required header-value or param. Note that functions called
- 'value2' works with Authorization-like headers where comma is not
- treated as value delimiter. Formats: @hf_value.HFNAME[IDX] # idx value,
- negative value counts from bottom @hf_value.HFNAME.PARAM_NAME
- @hf_value.HFNAME[IDX].PARAM_NAME @hf_value.HFNAME.p.PARAM_NAME # or
- .param., useful if required called "uri", "p", "param"
- @hf_value.HFNAME[IDX].p.PARAM_NAME # dtto @hf_value.HFNAME[IDX].uri #
- (< & > excluded) @hf_value.HFNAME[*] # return comma delimited list of
- all values (combines headers) @hf_value.HFNAME # the same as above [*]
- but may be parsed by cfg.y @hf_value.HFNAME[*].uri # return comma
- delimited list of uris (< & > excluded) @hf_value.HFNAME.uri # the same
- as above [*] but may be parsed by cfg.y @hf_value.HFNAME[IDX].name #
- returns name part, quotes excluded @hf_value.HFNAME.name # returns name
- part of the first value @hf_value2.HFNAME # returns value of first
- header @hf_value2.HFNAME[IDX] # returns value of idx's header
- @hf_value2.HFNAME.PARAM_NAME @hf_value2.HFNAME[IDX].PARAM_NAME
- @hf_value.HFNAME[IDX].uri # return URI, quotes excluded
- @hf_value.HFNAME.p.uri # returns param named uri, not URI itself
- @hf_value.HFNAME.p.name # returns param named name, not name itself
- @hf_value.HFNAME[IDX].uri.name # any sel_any_uri nested features may be
- used @hf_value.HFNAME[IDX].nameaddr.name # select_any_nameaddr
+ Get value of required header-value or param. Note that selects called
+ 'hf_value2' work with Authorization-like headers where comma is not
+ treated as value delimiter.
+
+ Formats:
+ * @hf_value.HFNAME[IDX] # idx value, negative value counts from
+ bottom
+ * @hf_value.HFNAME.PARAM_NAME
+ * @hf_value.HFNAME[IDX].PARAM_NAME
+ * @hf_value.HFNAME.p.PARAM_NAME # or .param., useful if required
+ called "uri", "p", "param"
+ * @hf_value.HFNAME[IDX].p.PARAM_NAME # dtto
+ * @hf_value.HFNAME[IDX].uri # (< & > excluded)
+ * @hf_value.HFNAME[*] # return comma delimited list of all values
+ (combines headers)
+ * @hf_value.HFNAME # the same as above [*] but may be parsed by cfg.y
+ * @hf_value.HFNAME[*].uri # return comma delimited list of uris (< &
+ > excluded)
+ * @hf_value.HFNAME.uri # the same as above [*] but may be parsed by
+ cfg.y
+ * @hf_value.HFNAME[IDX].name # returns name part, quotes excluded
+ * @hf_value.HFNAME.name # returns name part of the first value
+ * @hf_value2.HFNAME # returns value of first header
+ * @hf_value2.HFNAME[IDX] # returns value of idx's header
+ * @hf_value2.HFNAME.PARAM_NAME
+ * @hf_value2.HFNAME[IDX].PARAM_NAME
+ * @hf_value.HFNAME[IDX].uri # return URI, quotes excluded
+ * @hf_value.HFNAME.p.uri # returns param named uri, not URI itself
+ * @hf_value.HFNAME.p.name # returns param named name, not name itself
+ * @hf_value.HFNAME[IDX].uri.name # any sel_any_uri nested features
+ may be used
+ * @hf_value.HFNAME[IDX].nameaddr.name # select_any_nameaddr
Meaning of the parameters is as follows:
* HFNAME - Header field name. Underscores are treated as dashes.
@@ -772,7 +783,9 @@ $prt = @hf_value2.authorization.integrity_protected;
3.2. @hf_value2
- TBA.
+ Similar to selects called 'hf_value', but work with Authorization-like
+ headers where comma is treated as attribute delimiter instead of header
+ value delimiter.
3.3. @hf_value_exists
Module: kamailio
Branch: 5.8
Commit: 70cf3ebd2b52c341a90c9b9b6149985667a6b96c
URL: https://github.com/kamailio/kamailio/commit/70cf3ebd2b52c341a90c9b9b6149985…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2024-07-01T09:11:16+02:00
textopsx: docs - note about @hf_value2 select
(cherry picked from commit d13c741d90c3887cdf144a9094a78c0c7cb9856d)
---
Modified: src/modules/textopsx/doc/selects.xml
---
Diff: https://github.com/kamailio/kamailio/commit/70cf3ebd2b52c341a90c9b9b6149985…
Patch: https://github.com/kamailio/kamailio/commit/70cf3ebd2b52c341a90c9b9b6149985…
---
diff --git a/src/modules/textopsx/doc/selects.xml b/src/modules/textopsx/doc/selects.xml
index 3c72c21cd36..dd3ea3f7a62 100644
--- a/src/modules/textopsx/doc/selects.xml
+++ b/src/modules/textopsx/doc/selects.xml
@@ -8,8 +8,8 @@
<section id="textopsx.sel.hf_value">
<title>@hf_value</title>
<para>
- Get value of required header-value or param. Note that functions called 'value2'
- works with Authorization-like headers where comma is not treated as value delimiter.
+ Get value of required header-value or param. Note that selects called 'hf_value2'
+ work with Authorization-like headers where comma is not treated as value delimiter.
</para>
<para>
Formats:
@@ -73,7 +73,9 @@ $prt = @hf_value2.authorization.integrity_protected;
<section id="textopsx.sel.hf_value2">
<title>@hf_value2</title>
<para>
- TBA.
+ Similar to selects called 'hf_value', but work with Authorization-like
+ headers where comma is treated as attribute delimiter instead of header
+ value delimiter.
</para>
</section>
<section id="textopsx.sel.hf_value_exists">
Module: kamailio
Branch: 5.8
Commit: 7bf787d00f9f7ed8a2d758219d6d1413b2b5c975
URL: https://github.com/kamailio/kamailio/commit/7bf787d00f9f7ed8a2d758219d6d141…
Author: Dragos Vingarzan <vingarzan(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2024-07-01T09:10:51+02:00
textopx/doc: fixed hard-to-read documentation for textopsx
- was missing line-wraps in examples list, hence very hard to read
(cherry picked from commit 48d97c1941f660aa396b5ef100584611cf92ad21)
---
Modified: src/modules/textopsx/doc/selects.xml
---
Diff: https://github.com/kamailio/kamailio/commit/7bf787d00f9f7ed8a2d758219d6d141…
Patch: https://github.com/kamailio/kamailio/commit/7bf787d00f9f7ed8a2d758219d6d141…
---
diff --git a/src/modules/textopsx/doc/selects.xml b/src/modules/textopsx/doc/selects.xml
index 6d4dd4e3a25..3c72c21cd36 100644
--- a/src/modules/textopsx/doc/selects.xml
+++ b/src/modules/textopsx/doc/selects.xml
@@ -9,30 +9,35 @@
<title>@hf_value</title>
<para>
Get value of required header-value or param. Note that functions called 'value2'
- works with Authorization-like headers where comma is not treated as value delimiter. Formats:
- @hf_value.HFNAME[IDX] # idx value, negative value counts from bottom
- @hf_value.HFNAME.PARAM_NAME
- @hf_value.HFNAME[IDX].PARAM_NAME
- @hf_value.HFNAME.p.PARAM_NAME # or .param., useful if required called "uri", "p", "param"
- @hf_value.HFNAME[IDX].p.PARAM_NAME # dtto
- @hf_value.HFNAME[IDX].uri # (< & > excluded)
- @hf_value.HFNAME[*] # return comma delimited list of all values (combines headers)
- @hf_value.HFNAME # the same as above [*] but may be parsed by cfg.y
- @hf_value.HFNAME[*].uri # return comma delimited list of uris (< & > excluded)
- @hf_value.HFNAME.uri # the same as above [*] but may be parsed by cfg.y
- @hf_value.HFNAME[IDX].name # returns name part, quotes excluded
- @hf_value.HFNAME.name # returns name part of the first value
+ works with Authorization-like headers where comma is not treated as value delimiter.
+ </para>
+ <para>
+ Formats:
+ <itemizedlist>
+ <listitem>@hf_value.HFNAME[IDX] # idx value, negative value counts from bottom</listitem>
+ <listitem>@hf_value.HFNAME.PARAM_NAME</listitem>
+ <listitem>@hf_value.HFNAME[IDX].PARAM_NAME</listitem>
+ <listitem>@hf_value.HFNAME.p.PARAM_NAME # or .param., useful if required called "uri", "p", "param"</listitem>
+ <listitem>@hf_value.HFNAME[IDX].p.PARAM_NAME # dtto</listitem>
+ <listitem>@hf_value.HFNAME[IDX].uri # (< & > excluded)</listitem>
+ <listitem>@hf_value.HFNAME[*] # return comma delimited list of all values (combines headers)</listitem>
+ <listitem>@hf_value.HFNAME # the same as above [*] but may be parsed by cfg.y</listitem>
+ <listitem>@hf_value.HFNAME[*].uri # return comma delimited list of uris (< & > excluded)</listitem>
+ <listitem>@hf_value.HFNAME.uri # the same as above [*] but may be parsed by cfg.y</listitem>
+ <listitem>@hf_value.HFNAME[IDX].name # returns name part, quotes excluded</listitem>
+ <listitem>@hf_value.HFNAME.name # returns name part of the first value</listitem>
- @hf_value2.HFNAME # returns value of first header
- @hf_value2.HFNAME[IDX] # returns value of idx's header
- @hf_value2.HFNAME.PARAM_NAME
- @hf_value2.HFNAME[IDX].PARAM_NAME
+ <listitem>@hf_value2.HFNAME # returns value of first header</listitem>
+ <listitem>@hf_value2.HFNAME[IDX] # returns value of idx's header</listitem>
+ <listitem>@hf_value2.HFNAME.PARAM_NAME</listitem>
+ <listitem>@hf_value2.HFNAME[IDX].PARAM_NAME</listitem>
- @hf_value.HFNAME[IDX].uri # return URI, quotes excluded
- @hf_value.HFNAME.p.uri # returns param named uri, not URI itself
- @hf_value.HFNAME.p.name # returns param named name, not name itself
- @hf_value.HFNAME[IDX].uri.name # any sel_any_uri nested features may be used
- @hf_value.HFNAME[IDX].nameaddr.name # select_any_nameaddr
+ <listitem>@hf_value.HFNAME[IDX].uri # return URI, quotes excluded</listitem>
+ <listitem>@hf_value.HFNAME.p.uri # returns param named uri, not URI itself</listitem>
+ <listitem>@hf_value.HFNAME.p.name # returns param named name, not name itself</listitem>
+ <listitem>@hf_value.HFNAME[IDX].uri.name # any sel_any_uri nested features may be used</listitem>
+ <listitem>@hf_value.HFNAME[IDX].nameaddr.name # select_any_nameaddr</listitem>
+ </itemizedlist>
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>