Clarify documentation for channel and bridge list
authorKinsey Moore <kmoore@digium.com>
Wed, 16 Oct 2013 14:02:06 +0000 (14:02 +0000)
committerKinsey Moore <kmoore@digium.com>
Wed, 16 Oct 2013 14:02:06 +0000 (14:02 +0000)
This makes it clear that the ARI API calls for listing channels and
bridges will list all channels or bridges in the system and not just
those that are in or are controlled by a Stasis application.

(closes issue ASTERISK-22635)
Reported by: Kevin Harwell
........

Merged revisions 401087 from http://svn.asterisk.org/svn/asterisk/branches/12

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

res/ari/resource_bridges.h
res/ari/resource_channels.h
rest-api/api-docs/bridges.json
rest-api/api-docs/channels.json

index 5733171..abb372c 100644 (file)
@@ -43,7 +43,7 @@
 struct ast_get_bridges_args {
 };
 /*!
- * \brief List active bridges.
+ * \brief List all active bridges in Asterisk.
  *
  * \param headers HTTP headers
  * \param args Swagger parameters
index 699424e..b7f1ef2 100644 (file)
@@ -43,7 +43,7 @@
 struct ast_get_channels_args {
 };
 /*!
- * \brief List active channels.
+ * \brief List all active channels in Asterisk.
  *
  * \param headers HTTP headers
  * \param args Swagger parameters
index ec7cdae..819c777 100644 (file)
@@ -13,7 +13,7 @@
                        "operations": [
                                {
                                        "httpMethod": "GET",
-                                       "summary": "List active bridges.",
+                                       "summary": "List all active bridges in Asterisk.",
                                        "nickname": "getBridges",
                                        "responseClass": "List[Bridge]"
                                },
index eeb56a5..40ccda7 100644 (file)
@@ -13,7 +13,7 @@
                        "operations": [
                                {
                                        "httpMethod": "GET",
-                                       "summary": "List active channels.",
+                                       "summary": "List all active channels in Asterisk.",
                                        "nickname": "getChannels",
                                        "responseClass": "List[Channel]"
                                },