Multiple revisions 398638-398639

........
  r398638 | dlee | 2013-09-09 14:01:54 -0500 (Mon, 09 Sep 2013) | 1 line

  Added note about expected behavior of originate
........
  r398639 | dlee | 2013-09-09 14:02:27 -0500 (Mon, 09 Sep 2013) | 1 line

  Added note about expected behavior of originate (the rest of the commit)
........

Merged revisions 398638-398639 from http://svn.asterisk.org/svn/asterisk/branches/12

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

diff --git a/res/ari/resource_channels.h b/res/ari/resource_channels.h
index 953d58f4eb67be3af3ed107d071c158ee2d88b16..e4dcc1b7d4d55892b6676a5b6e8384a601011d6a 100644 (file)
--- a/res/ari/resource_channels.h
+++ b/res/ari/resource_channels.h
@@ -72,6 +72,8 @@ struct ast_originate_args {
 /*!
  * \brief Create a new channel (originate).
  *
+ * The new channel is not created until the dialed party picks up. Not wanting to block this request indefinitely, this request returns immediately with a 204 No Content. When the channel is created, a StasisStart event is sent with the provided app and appArgs. In the event of a failure (timeout, busy, etc.), an OriginationFailed event is sent.
+ *
  * \param headers HTTP headers
  * \param args Swagger parameters
  * \param[out] response HTTP response

diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json
index 0f3b8e20e684352831dbd714aa61ed89689dd727..b408d8b173cc3071e31594fee6fa2de40f748bc9 100644 (file)
--- a/rest-api/api-docs/channels.json
+++ b/rest-api/api-docs/channels.json
@@ -20,6 +20,7 @@
                                {
                                        "httpMethod": "POST",
                                        "summary": "Create a new channel (originate).",
+                                       "notes": "The new channel is not created until the dialed party picks up. Not wanting to block this request indefinitely, this request returns immediately with a 204 No Content. When the channel is created, a StasisStart event is sent with the provided app and appArgs. In the event of a failure (timeout, busy, etc.), an OriginationFailed event is sent.",
                                        "nickname": "originate",
                                        "responseClass": "void",
                                        "parameters": [