Update CHANGES and UPGRADE.txt for 17.3.0

diff --git a/CHANGES b/CHANGES
index 9b27a2584a3cf04174f55fd695e743df14c42433..8e3e912ed901f4299ce5b4689282924f3b7dce01 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -12,6 +12,31 @@
 ===
 ==============================================================================
 
+------------------------------------------------------------------------------
+--- Functionality changes from Asterisk 17.2.0 to Asterisk 17.3.0 ------------
+------------------------------------------------------------------------------
+
+Messaging
+------------------
+ * In order to reduce the amount of AMI and ARI events generated,
+   the global "Message/ast_msg_queue" channel can be set to suppress
+   it's normal channel housekeeping events such as "Newexten",
+   "VarSet", etc. This can greatly reduce load on the manager
+   and ARI applications when the Digium Phone Module for Asterisk
+   is in use.  To enable, set "hide_messaging_ami_events" in
+   asterisk.conf to "yes"  In Asterisk versions <18, the default
+   is "no" preserving existing behavior.  Beginning with
+   Asterisk 18, the option will default to "yes".
+
+app_mixmonitor
+------------------
+ * If the 'filename' argument to MixMonitor() ended with '.wav49,'
+   Asterisk would silently convert the extension to '.WAV' when opening
+   the file for writing. This caused the MIXMONITOR_FILENAME variable to
+   reference the wrong file. The MIXMONITOR_FILENAME variable will now
+   reflect the name of the file that Asterisk actually used instead of
+   the filename that was passed to the application.
+
 ------------------------------------------------------------------------------
 --- Functionality changes from Asterisk 17.1.0 to Asterisk 17.2.0 ------------
 ------------------------------------------------------------------------------

diff --git a/UPGRADE.txt b/UPGRADE.txt
index 57237d8c81a659718bddf90d2f2003b362c6a261..6be7d06661b40ae4d5c9fd40d593903a626bba86 100644 (file)
--- a/UPGRADE.txt
+++ b/UPGRADE.txt
@@ -18,6 +18,62 @@
 ===
 ===========================================================
 
+------------------------------------------------------------------------------
+--- Functionality changes from Asterisk 17.2.0 to Asterisk 17.3.0 ------------
+------------------------------------------------------------------------------
+
+ARI
+------------------
+ * The "TextMessageReceived" event used to include a list of "TextMessageVariable"
+   objects as part of its output. Due to a couple of bugs in Asterisk a list of
+   received variables was never included even if ones were available. However,
+   variables set to send would be (which they should have not been), but would
+   fail validation due to the bad formatting.
+
+   So basically there was no way to get a "TextMessageReceived" event with
+   variables. Due to this the API has changed. The "TextMessageVariable" object
+   no longer exists. "TextMessageReceived" now returns a JSON object of key/value
+   pairs. So for instance instead of a list of "TextMessageVariable" objects:
+
+   [ TextMessageVariable, TextMessageVariable, TextMessageVariable]
+
+   where a TextMessageVariable was supposed to be:
+
+   { "key": "<var name>", "value":, "<var value>" }
+
+   The output is now just:
+
+   { "<var name>": "<var value>" }
+
+   This aligns more with how variables are specified when sending a message, as
+   well as other variable lists in ARI.
+
+res_stasis
+------------------
+ * The "TextMessageReceived" event used to include a list of "TextMessageVariable"
+   objects as part of its output. Due to a couple of bugs in Asterisk a list of
+   received variables was never included even if ones were available. However,
+   variables set to send would be (which they should have not been), but would
+   fail validation due to the bad formatting.
+
+   So basically there was no way to get a "TextMessageReceived" event with
+   variables. Due to this the API has changed. The "TextMessageVariable" object
+   no longer exists. "TextMessageReceived" now returns a JSON object of key/value
+   pairs. So for instance instead of a list of "TextMessageVariable" objects:
+
+   [ TextMessageVariable, TextMessageVariable, TextMessageVariable]
+
+   where a TextMessageVariable was supposed to be:
+
+   { "key": "<var name>", "value":, "<var value>" }
+
+   The output is now just:
+
+   { "<var name>": "<var value>" }
+
+   This aligns more with how variables are specified when sending a message, as
+   well as other variable lists in ARI.
+
 ------------------------------------------------------------------------------
 --- Functionality changes from Asterisk 17.0.0 to Asterisk 17.1.0 ------------
 ------------------------------------------------------------------------------

diff --git a/doc/CHANGES-staging/app_mixmonitor_wav49.txt b/doc/CHANGES-staging/app_mixmonitor_wav49.txt
deleted file mode 100644 (file)
index f3218d7..0000000
--- a/doc/CHANGES-staging/app_mixmonitor_wav49.txt
+++ /dev/null
@@ -1,8 +0,0 @@
-Subject: app_mixmonitor
-
-If the 'filename' argument to MixMonitor() ended with '.wav49,'
-Asterisk would silently convert the extension to '.WAV' when opening
-the file for writing. This caused the MIXMONITOR_FILENAME variable to
-reference the wrong file. The MIXMONITOR_FILENAME variable will now
-reflect the name of the file that Asterisk actually used instead of
-the filename that was passed to the application.

diff --git a/doc/CHANGES-staging/hide_messaging_ami_events.txt b/doc/CHANGES-staging/hide_messaging_ami_events.txt
deleted file mode 100644 (file)
index 0afbeec..0000000
--- a/doc/CHANGES-staging/hide_messaging_ami_events.txt
+++ /dev/null
@@ -1,11 +0,0 @@
-Subject: Messaging
-
-In order to reduce the amount of AMI and ARI events generated,
-the global "Message/ast_msg_queue" channel can be set to suppress
-it's normal channel housekeeping events such as "Newexten",
-"VarSet", etc. This can greatly reduce load on the manager
-and ARI applications when the Digium Phone Module for Asterisk
-is in use.  To enable, set "hide_messaging_ami_events" in
-asterisk.conf to "yes"  In Asterisk versions <18, the default
-is "no" preserving existing behavior.  Beginning with
-Asterisk 18, the option will default to "yes".

diff --git a/doc/UPGRADE-staging/ari_messaging.txt b/doc/UPGRADE-staging/ari_messaging.txt
deleted file mode 100644 (file)
index 199a8a2..0000000
--- a/doc/UPGRADE-staging/ari_messaging.txt
+++ /dev/null
@@ -1,26 +0,0 @@
-Subject: ARI
-Subject: res_stasis
-
-The "TextMessageReceived" event used to include a list of "TextMessageVariable"
-objects as part of its output. Due to a couple of bugs in Asterisk a list of
-received variables was never included even if ones were available. However,
-variables set to send would be (which they should have not been), but would
-fail validation due to the bad formatting.
-
-So basically there was no way to get a "TextMessageReceived" event with
-variables. Due to this the API has changed. The "TextMessageVariable" object
-no longer exists. "TextMessageReceived" now returns a JSON object of key/value
-pairs. So for instance instead of a list of "TextMessageVariable" objects:
-
-[ TextMessageVariable, TextMessageVariable, TextMessageVariable]
-
-where a TextMessageVariable was supposed to be:
-
-{ "key": "<var name>", "value":, "<var value>" }
-
-The output is now just:
-
-{ "<var name>": "<var value>" }
-
-This aligns more with how variables are specified when sending a message, as
-well as other variable lists in ARI.