[sr-dev] git:master:9c060a66: nathelper: docs for mode parameter for handle_ruri_alias()

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 9c060a66f83a42c46767f5b28b6a3640764ebb87
URL: https://github.com/kamailio/kamailio/commit/9c060a66f83a42c46767f5b28b6a3640764ebb87

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2021-06-01T09:29:33+02:00

nathelper: docs for mode parameter for handle_ruri_alias()

---

Modified: src/modules/nathelper/doc/nathelper_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/9c060a66f83a42c46767f5b28b6a3640764ebb87.diff
Patch: https://github.com/kamailio/kamailio/commit/9c060a66f83a42c46767f5b28b6a3640764ebb87.patch

---

diff --git a/src/modules/nathelper/doc/nathelper_admin.xml b/src/modules/nathelper/doc/nathelper_admin.xml
index 5096a676d4..39e61e6856 100644
--- a/src/modules/nathelper/doc/nathelper_admin.xml
+++ b/src/modules/nathelper/doc/nathelper_admin.xml
@@ -794,17 +794,21 @@ if(is_rfc1918("$rd")) {
 
 	<section id="nathelper.f.handle_ruri_alias">
 		<title>
-		<function moreinfo="none">handle_ruri_alias()</function>
+		<function moreinfo="none">handle_ruri_alias([mode])</function>
 		</title>
 		<para>
 		Checks if the Request URI has an <quote>alias</quote>
 		parameter and if so, removes it and sets the <quote>$du</quote> based
-		on its value.  Note that this means that routing of request is based on 
-		<quote>;alias</quote> parameter value of the Request URI rather than 
+		on its value. Note that this means that routing of request is based on
+		<quote>;alias</quote> parameter value of the Request URI rather than
 		the Request URI itself. If you call <function>handle_ruri_alias()</function>
 		on a request, make sure that you screen the alias parameter value of
-		Request URI the same way as you would screen the
-		Request URI itself.
+		Request URI the same way as you would screen the Request URI itself.
+		</para>
+		<para>
+		The optional parameter mode can be 0 to consume first alias parameter,
+		otherwise it consumes the last alias parameter. If the parameter mode is
+		not provided, it consumes the first parameter.
 		</para>
 		<para>
 		Returns <emphasis>1</emphasis> if <quote>;alias</quote> parameter was