[asterisk-commits] dlee: branch dlee/stasis-http r383044 - /team/dlee/stasis-http/rest-api/

[SVN commits to the Asterisk project]

Author: dlee
Date: Wed Mar 13 17:05:01 2013
New Revision: 383044

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=383044
Log:
Document the Channel model

Modified:
    team/dlee/stasis-http/rest-api/channels.json

Modified: team/dlee/stasis-http/rest-api/channels.json
URL: http://svnview.digium.com/svn/asterisk/team/dlee/stasis-http/rest-api/channels.json?view=diff&rev=383044&r1=383043&r2=383044
==============================================================================
--- team/dlee/stasis-http/rest-api/channels.json (original)
+++ team/dlee/stasis-http/rest-api/channels.json Wed Mar 13 17:05:01 2013
@@ -15,7 +15,7 @@
                     "httpMethod": "GET",
                     "summary": "List active channels",
                     "nickname": "getChannels",
-                    "responseClass": "Channels"
+                    "responseClass": "List[Channel]"
                 },
                 {
                     "httpMethod": "POST",
@@ -356,5 +356,110 @@
             ]
         }
     ],
-    "models": {}
+    "models": {
+        "DialplanCEP": {
+            "id": "DialplanCEP",
+            "properties": {
+                "context": {
+                    "required": true,
+                    "type": "string",
+                    "description": "Context in the dialplan"
+                },
+                "exten": {
+                    "required": true,
+                    "type": "string",
+                    "description": "Extension in the dialplan"
+                },
+                "priority": {
+                    "required": true,
+                    "type": "long",
+                    "description": "Priority in the dialplan"
+                }
+            }
+        },
+        "CallerID": {
+            "id": "CallerID",
+            "properties": {
+                "name": {
+                    "required": true,
+                    "type": "string"
+                },
+                "number": {
+                    "required": true,
+                    "type": "string"
+                }
+            }
+        },
+        "Channel": {
+            "id": "Channel",
+            "properties": {
+                "uniqueid": {
+                    "required": true,
+                    "type": "string",
+                    "description": "Unique identifier of the channel"
+                },
+                "name": {
+                    "required": true,
+                    "type": "string",
+                    "description": "Name of the channel (i.e. SIP/foo-0000a7e3)"
+                },
+                "state": {
+                    "required": true,
+                    "type": "string"
+                },
+                "accountcode": {
+                    "required": true,
+                    "type": "string"
+                },
+                "peeraccount": {
+                    "required": true,
+                    "type": "string"
+                },
+                "userfield": {
+                    "required": true,
+                    "type": "string"
+                },
+                "linkedid": {
+                    "required": true,
+                    "type": "string"
+                },
+                "parkinglot": {
+                    "required": true,
+                    "type": "string"
+                },
+                "hangupsource": {
+                    "required": true,
+                    "type": "string"
+                },
+                "appl": {
+                    "required": true,
+                    "type": "string",
+                    "description": "Currently executing dialplan application"
+                },
+                "data": {
+                    "required": true,
+                    "type": "string",
+                    "description": "Arguments passed to appl"
+                },
+                "dialplan": {
+                    "required": true,
+                    "type": "DialplanCEP",
+                    "description": "Current location in the dialplan"
+                },
+                "caller": {
+                    "required": true,
+                    "type": "CallerID"
+                },
+                "connected": {
+                    "required": true,
+                    "type": "CallerID"
+                },
+                "creationtime": {
+                    "required": true,
+                    "type": "string",
+                    "description": "Timestamp when channel was created"
+                }
+            }
+        }
+    }
 }