[sr-dev] git:master:3466fc59: dialog: docs for attrs parameter of dlg.briefing rpc command

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 3466fc59abff5153c99b438f1e4becdfcba77b6b
URL: https://github.com/kamailio/kamailio/commit/3466fc59abff5153c99b438f1e4becdfcba77b6b

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-04-09T09:42:58+02:00

dialog: docs for attrs parameter of dlg.briefing rpc command

---

Modified: src/modules/dialog/doc/dialog_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/3466fc59abff5153c99b438f1e4becdfcba77b6b.diff
Patch: https://github.com/kamailio/kamailio/commit/3466fc59abff5153c99b438f1e4becdfcba77b6b.patch

---

diff --git a/src/modules/dialog/doc/dialog_admin.xml b/src/modules/dialog/doc/dialog_admin.xml
index aeae7da454..987bd54545 100644
--- a/src/modules/dialog/doc/dialog_admin.xml
+++ b/src/modules/dialog/doc/dialog_admin.xml
@@ -2865,19 +2865,58 @@ dlg_reset_property("timeout-noreset");
 		<section id="dlg.r.briefing">
 		<title>dlg.briefing</title>
 		<para>
-		Lists fewer attributes for dialog records in memory.
+		Lists fewer attributes for dialog records in memory. The dialog hash
+		entry and id are added always, the rest of them are a matter of 'attrs'
+		parameter.
 		</para>
 		<para>Name: <emphasis>dlg.briefing</emphasis></para>
 		<para>Parameters:</para>
 		<itemizedlist>
 			<listitem><para>
-				<emphasis>none</emphasis> - no parameter
-			</para></listitem>
+			<emphasis>attrs</emphasis> - (optional) a list of characters (flags)
+			representing the fields to be added to the response. If is missing,
+			its default value is 'ftcFT' (note the characters are case sensitive).
+			</para>
+			<para>
+				The characters can be:
+				<itemizedlist>
+				<listitem><para>
+					<emphasis>f</emphasis> - From URI
+				</para></listitem>
+				<listitem><para>
+					<emphasis>t</emphasis> - To URI
+				</para></listitem>
+				<listitem><para>
+					<emphasis>c</emphasis> - Call-ID
+				</para></listitem>
+				<listitem><para>
+					<emphasis>F</emphasis> - From tag
+				</para></listitem>
+				<listitem><para>
+					<emphasis>T</emphasis> - To tag
+				</para></listitem>
+				<listitem><para>
+					<emphasis>I</emphasis> - Init time
+				</para></listitem>
+				<listitem><para>
+					<emphasis>S</emphasis> - Start time
+				</para></listitem>
+				<listitem><para>
+					<emphasis>E</emphasis> - End time
+				</para></listitem>
+				<listitem><para>
+					<emphasis>s</emphasis> - State
+				</para></listitem>
+				</itemizedlist>
+			</para>
+			</listitem>
 		</itemizedlist>
 		<para>RPC Command Example:</para>
 		<programlisting  format="linespecific">
 ...
 kamctl rpc dlg.briefing
+...
+kamctl rpc dlg.briefing "ft"
 ...
 		</programlisting>
 		</section>