res_ari: Add notes about Asterisk HTTP server to the "enabled" config option for...

Added note and see-also reminding user to enable the HTTP server.

(closes issue ASTERISK-22499)
Reported by: Rusty Newton

git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/12@410876 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/res/res_ari.c b/res/res_ari.c
index 66bc4280aefcee6d46d5db0c2a3f5a1a70178d7a..236b257735b6610082d75fc738ee7cace94f6f87 100644 (file)
--- a/res/res_ari.c
+++ b/res/res_ari.c
@@ -84,6 +84,14 @@
                                <synopsis>General configuration settings</synopsis>
                                <configOption name="enabled">
                                        <synopsis>Enable/disable the ARI module</synopsis>
+                                       <description>This option enables or disables the ARI module.
+                                               <note><para>Asterisk's HTTP server also needs to be enabled for ARI to communicate over it.
+                                               </para></note>
+                                       </description>
+                                       <see-also>
+                                               <ref type="filename">http.conf</ref>
+                                               <ref type="link">https://wiki.asterisk.org/wiki/display/AST/Asterisk+Builtin+mini-HTTP+Server</ref>
+                                       </see-also>
                                </configOption>
                                <configOption name="pretty">
                                        <synopsis>Responses from ARI are formatted to be human readable</synopsis>