[svn-commits] dlee: branch dlee/ari-event-remodel r391810 - /team/dlee/ari-event-remodel/re...
SVN commits to the Digium repositories
svn-commits at lists.digium.com
Fri Jun 14 11:26:58 CDT 2013
Author: dlee
Date: Fri Jun 14 11:26:57 2013
New Revision: 391810
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=391810
Log:
Document the models
Modified:
team/dlee/ari-event-remodel/rest-api/api-docs/asterisk.json
team/dlee/ari-event-remodel/rest-api/api-docs/bridges.json
team/dlee/ari-event-remodel/rest-api/api-docs/channels.json
team/dlee/ari-event-remodel/rest-api/api-docs/endpoints.json
team/dlee/ari-event-remodel/rest-api/api-docs/playback.json
team/dlee/ari-event-remodel/rest-api/api-docs/recordings.json
team/dlee/ari-event-remodel/rest-api/api-docs/sounds.json
Modified: team/dlee/ari-event-remodel/rest-api/api-docs/asterisk.json
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ari-event-remodel/rest-api/api-docs/asterisk.json?view=diff&rev=391810&r1=391809&r2=391810
==============================================================================
--- team/dlee/ari-event-remodel/rest-api/api-docs/asterisk.json (original)
+++ team/dlee/ari-event-remodel/rest-api/api-docs/asterisk.json Fri Jun 14 11:26:57 2013
@@ -41,6 +41,7 @@
"models": {
"AsteriskInfo": {
"id": "AsteriskInfo",
+ "description": "Asterisk system information",
"properties": {}
}
}
Modified: team/dlee/ari-event-remodel/rest-api/api-docs/bridges.json
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ari-event-remodel/rest-api/api-docs/bridges.json?view=diff&rev=391810&r1=391809&r2=391810
==============================================================================
--- team/dlee/ari-event-remodel/rest-api/api-docs/bridges.json (original)
+++ team/dlee/ari-event-remodel/rest-api/api-docs/bridges.json Fri Jun 14 11:26:57 2013
@@ -232,6 +232,7 @@
"models": {
"Bridge": {
"id": "Bridge",
+ "description": "The merging of media from one or more channels.\n\nEveryone on the bridge receives the same audio.",
"properties": {
"bridgeType": {
"type": "string",
Modified: team/dlee/ari-event-remodel/rest-api/api-docs/channels.json
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ari-event-remodel/rest-api/api-docs/channels.json?view=diff&rev=391810&r1=391809&r2=391810
==============================================================================
--- team/dlee/ari-event-remodel/rest-api/api-docs/channels.json (original)
+++ team/dlee/ari-event-remodel/rest-api/api-docs/channels.json Fri Jun 14 11:26:57 2013
@@ -589,10 +589,12 @@
"models": {
"Dialed": {
"id": "Dialed",
+ "description": "Dialed channel information.",
"properties": {}
},
"DialplanCEP": {
"id": "DialplanCEP",
+ "description": "Dialplan location (context/extension/priority)",
"properties": {
"context": {
"required": true,
@@ -613,6 +615,7 @@
},
"CallerID": {
"id": "CallerID",
+ "description": "Caller identification",
"properties": {
"name": {
"required": true,
@@ -626,6 +629,7 @@
},
"Channel": {
"id": "Channel",
+ "description": "A specific communication connection between Asterisk and an Endpoint.",
"properties": {
"uniqueid": {
"required": true,
@@ -692,44 +696,6 @@
"required": true,
"type": "Date",
"description": "Timestamp when channel was created"
- }
- }
- },
- "Playback": {
- "id": "Playback",
- "description": "Object representing the playback of media to a channel",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID for this playback operation",
- "required": true
- },
- "media_uri": {
- "type": "string",
- "description": "URI for the media to play back.",
- "required": true
- },
- "target_uri": {
- "type": "string",
- "description": "URI for the channel or bridge to play the media on",
- "required": true
- },
- "language": {
- "type": "string",
- "description": "For media types that support multiple languages, the language requested for playback."
- },
- "state": {
- "type": "string",
- "description": "Current state of the playback operation.",
- "required": true,
- "allowableValues": {
- "valueType": "LIST",
- "values": [
- "queued",
- "playing",
- "complete"
- ]
- }
}
}
}
Modified: team/dlee/ari-event-remodel/rest-api/api-docs/endpoints.json
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ari-event-remodel/rest-api/api-docs/endpoints.json?view=diff&rev=391810&r1=391809&r2=391810
==============================================================================
--- team/dlee/ari-event-remodel/rest-api/api-docs/endpoints.json (original)
+++ team/dlee/ari-event-remodel/rest-api/api-docs/endpoints.json Fri Jun 14 11:26:57 2013
@@ -69,7 +69,7 @@
"models": {
"Endpoint": {
"id": "Endpoint",
- "description": "A snapshot of an endpoint. Unlike most resources, which have a single unique identifier, an endpoint is uniquely identified by the technology/resource pair.",
+ "description": "An external device that may offer/accept calls to/from Asterisk.\n\nUnlike most resources, which have a single unique identifier, an endpoint is uniquely identified by the technology/resource pair.",
"properties": {
"technology": {
"type": "string",
Modified: team/dlee/ari-event-remodel/rest-api/api-docs/playback.json
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ari-event-remodel/rest-api/api-docs/playback.json?view=diff&rev=391810&r1=391809&r2=391810
==============================================================================
--- team/dlee/ari-event-remodel/rest-api/api-docs/playback.json (original)
+++ team/dlee/ari-event-remodel/rest-api/api-docs/playback.json Fri Jun 14 11:26:57 2013
@@ -103,11 +103,39 @@
"models": {
"Playback": {
"id": "Playback",
+ "description": "Object representing the playback of media to a channel",
"properties": {
"id": {
+ "type": "string",
+ "description": "ID for this playback operation",
+ "required": true
+ },
+ "media_uri": {
+ "type": "string",
+ "description": "URI for the media to play back.",
+ "required": true
+ },
+ "target_uri": {
+ "type": "string",
+ "description": "URI for the channel or bridge to play the media on",
+ "required": true
+ },
+ "language": {
+ "type": "string",
+ "description": "For media types that support multiple languages, the language requested for playback."
+ },
+ "state": {
+ "type": "string",
+ "description": "Current state of the playback operation.",
"required": true,
- "description": "Playback's identifier.",
- "type": "string"
+ "allowableValues": {
+ "valueType": "LIST",
+ "values": [
+ "queued",
+ "playing",
+ "complete"
+ ]
+ }
}
}
}
Modified: team/dlee/ari-event-remodel/rest-api/api-docs/recordings.json
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ari-event-remodel/rest-api/api-docs/recordings.json?view=diff&rev=391810&r1=391809&r2=391810
==============================================================================
--- team/dlee/ari-event-remodel/rest-api/api-docs/recordings.json (original)
+++ team/dlee/ari-event-remodel/rest-api/api-docs/recordings.json Fri Jun 14 11:26:57 2013
@@ -226,43 +226,36 @@
}
],
"models": {
- "Recording": {
- "id": "Recording",
+ "StoredRecording": {
+ "id": "StoredRecording",
+ "description": "A past recording that may be played back.",
"properties": {
"id": {
"required": true,
"type": "string"
+ },
+ "formats": {
+ "required": true,
+ "type": "List[string]"
+ },
+ "durationSeconds": {
+ "required": false,
+ "type": "int"
+ },
+ "time": {
+ "description": "Time recording was started",
+ "required": false,
+ "type": "Date"
}
}
},
- "StoredRecording": {
- "id": "StoredRecording",
+ "LiveRecording": {
+ "id": "LiveRecording",
+ "description": "A recording that is in progress",
"properties": {
"id": {
"required": true,
"type": "string"
- },
- "formats": {
- "required": true,
- "type": "List[string]"
- },
- "durationSeconds": {
- "required": false,
- "type": "int"
- },
- "time": {
- "description": "Time recording was started",
- "required": false,
- "type": "Date"
- }
- }
- },
- "LiveRecording": {
- "id": "LiveRecording",
- "properties": {
- "id": {
- "required": true,
- "type": "string"
}
}
}
Modified: team/dlee/ari-event-remodel/rest-api/api-docs/sounds.json
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ari-event-remodel/rest-api/api-docs/sounds.json?view=diff&rev=391810&r1=391809&r2=391810
==============================================================================
--- team/dlee/ari-event-remodel/rest-api/api-docs/sounds.json (original)
+++ team/dlee/ari-event-remodel/rest-api/api-docs/sounds.json Fri Jun 14 11:26:57 2013
@@ -60,6 +60,7 @@
"models": {
"Sound": {
"id": "Sound",
+ "description": "A media file that may be played back.",
"properties": {
"id": {
"required": true,
More information about the svn-commits
mailing list