[sr-dev] git:master:825800e6: uac: updated docs for uac_auth()

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 825800e6d3f297076bcce90f1f82c65a91cbb583
URL: https://github.com/kamailio/kamailio/commit/825800e6d3f297076bcce90f1f82c65a91cbb583

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2019-10-29T09:25:06+01:00

uac: updated docs for uac_auth()

---

Modified: src/modules/uac/doc/uac_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/825800e6d3f297076bcce90f1f82c65a91cbb583.diff
Patch: https://github.com/kamailio/kamailio/commit/825800e6d3f297076bcce90f1f82c65a91cbb583.patch

---

diff --git a/src/modules/uac/doc/uac_admin.xml b/src/modules/uac/doc/uac_admin.xml
index e0ea527776..f718924dad 100644
--- a/src/modules/uac/doc/uac_admin.xml
+++ b/src/modules/uac/doc/uac_admin.xml
@@ -802,14 +802,18 @@ uac_restore_to();
 		</section>
 		<section id="uac.f.uac_auth">
 			<title>
-				<function moreinfo="none">uac_auth()</function>
+				<function moreinfo="none">uac_auth([mode])</function>
 			</title>
 			<para>
-			This function can be called only from failure route and will 
+			This function can be called only from failure route and will
 			build the authentication response header and insert it into the
 			request without sending anything.
 			</para>
 			<para>
+			If mode is set to 1, then the password has to be provided in HA1 format.
+			The parameter can be a static integer or a variable holding an integer value.
+			</para>
+			<para>
 			This function can be used from FAILURE_ROUTE.
 			</para>
 			<example>
@@ -836,7 +840,9 @@ failure_route[TRUNKAUTH] {
     if(t_check_status("401|407")) {
         $avp(auser) = "test";
         $avp(apass) = "test";
+        # $avp(apass) = "36d0a02793542b4961e8348347236dbf";
         uac_auth();
+        # uac_auth("1");
         t_relay();
         exit;
     }