ari: User better nicknames for ARI operations

While working on building client libraries from the Swagger API, I
noticed a problem with the nicknames.

    channel.deleteChannel()
    channel.answerChannel()
    channel.muteChannel()

Etc. We put the object name in the nickname (since we were generating C
code), but it makes OO generators redundant.

This patch makes the nicknames more OO friendly. This resulted in a lot
of name changing within the res_ari_*.so modules, but not much else.

There were a couple of other fixed I made in the process.

 * When reversible operations (POST /hold, POST /unhold) were made more
   RESTful (POST /hold, DELETE /unhold), the path for the second operation
   was left in the API declaration. This worked, but really the two
   operations should have been on the same API.
 * The POST /unmute operation had still not been REST-ified.

Review: https://reviewboard.asterisk.org/r/2940/
........

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


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@402529 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
David M. Lee
2013-11-07 21:10:31 +00:00
parent cdfbc02df1
commit 7d0d1a1efb
41 changed files with 614 additions and 619 deletions

View File

@@ -14,14 +14,14 @@
{
"httpMethod": "GET",
"summary": "List all active bridges in Asterisk.",
"nickname": "getBridges",
"nickname": "list",
"responseClass": "List[Bridge]"
},
{
"httpMethod": "POST",
"summary": "Create a new bridge.",
"notes": "This bridge persists until it has been shut down, or Asterisk has been shut down.",
"nickname": "newBridge",
"nickname": "create",
"responseClass": "Bridge",
"parameters": [
{
@@ -50,7 +50,7 @@
{
"httpMethod": "GET",
"summary": "Get bridge details.",
"nickname": "getBridge",
"nickname": "get",
"responseClass": "Bridge",
"parameters": [
{
@@ -73,7 +73,7 @@
"httpMethod": "DELETE",
"summary": "Shut down a bridge.",
"notes": "If any channels are in this bridge, they will be removed and resume whatever they were doing beforehand.",
"nickname": "deleteBridge",
"nickname": "destroy",
"responseClass": "void",
"parameters": [
{
@@ -101,7 +101,7 @@
{
"httpMethod": "POST",
"summary": "Add a channel to a bridge.",
"nickname": "addChannelToBridge",
"nickname": "addChannel",
"responseClass": "void",
"parameters": [
{
@@ -157,7 +157,7 @@
{
"httpMethod": "POST",
"summary": "Remove a channel from a bridge.",
"nickname": "removeChannelFromBridge",
"nickname": "removeChannel",
"responseClass": "void",
"parameters": [
{
@@ -205,7 +205,7 @@
{
"httpMethod": "POST",
"summary": "Play music on hold to a bridge or change the MOH class that is playing.",
"nickname": "mohStartBridge",
"nickname": "startMoh",
"responseClass": "void",
"parameters": [
{
@@ -235,18 +235,12 @@
"reason": "Bridge not in Stasis application"
}
]
}
]
},
{
"path": "/bridges/{bridgeId}/moh",
"description": "Stop music on hold for a bridge",
"operations": [
},
{
"httpMethod": "DELETE",
"summary": "Stop playing music on hold to a bridge.",
"notes": "This will only stop music on hold being played via bridges/{bridgeId}/mohStart.",
"nickname": "mohStopBridge",
"notes": "This will only stop music on hold being played via POST bridges/{bridgeId}/moh.",
"nickname": "stopMoh",
"responseClass": "void",
"parameters": [
{
@@ -279,7 +273,7 @@
"httpMethod": "POST",
"summary": "Start playback of media on a bridge.",
"notes": "The media URI may be any of a number of URI's. Currently sound: and recording: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)",
"nickname": "playOnBridge",
"nickname": "play",
"responseClass": "Playback",
"parameters": [
{
@@ -356,7 +350,7 @@
"httpMethod": "POST",
"summary": "Start a recording.",
"notes": "This records the mixed audio from all channels participating in this bridge.",
"nickname": "recordBridge",
"nickname": "record",
"responseClass": "LiveRecording",
"parameters": [
{