mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-29 18:19:30 +00:00
2f92695c22
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/
git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/12@402528 65c4cc65-6c06-0410-ace0-fbb531ad65f3
322 lines
7.1 KiB
JSON
322 lines
7.1 KiB
JSON
{
|
|
"_copyright": "Copyright (C) 2012 - 2013, Digium, Inc.",
|
|
"_author": "David M. Lee, II <dlee@digium.com>",
|
|
"_svn_revision": "$Revision$",
|
|
"apiVersion": "0.0.1",
|
|
"swaggerVersion": "1.1",
|
|
"basePath": "http://localhost:8088/stasis",
|
|
"resourcePath": "/api-docs/recordings.{format}",
|
|
"apis": [
|
|
{
|
|
"path": "/recordings/stored",
|
|
"description": "Recordings",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "GET",
|
|
"summary": "List recordings that are complete.",
|
|
"nickname": "listStored",
|
|
"responseClass": "List[StoredRecording]"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/recordings/stored/{recordingName}",
|
|
"description": "Individual recording",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "GET",
|
|
"summary": "Get a stored recording's details.",
|
|
"nickname": "getStored",
|
|
"responseClass": "StoredRecording",
|
|
"parameters": [
|
|
{
|
|
"name": "recordingName",
|
|
"description": "The name of the recording",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"allowMultiple": false,
|
|
"dataType": "string"
|
|
}
|
|
],
|
|
"errorResponses": [
|
|
{
|
|
"code": 404,
|
|
"reason": "Recording not found"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"httpMethod": "DELETE",
|
|
"summary": "Delete a stored recording.",
|
|
"nickname": "deleteStored",
|
|
"responseClass": "void",
|
|
"parameters": [
|
|
{
|
|
"name": "recordingName",
|
|
"description": "The name of the recording",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"allowMultiple": false,
|
|
"dataType": "string"
|
|
}
|
|
],
|
|
"errorResponses": [
|
|
{
|
|
"code": 404,
|
|
"reason": "Recording not found"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/recordings/live/{recordingName}",
|
|
"description": "A recording that is in progress",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "GET",
|
|
"summary": "List live recordings.",
|
|
"nickname": "getLive",
|
|
"responseClass": "LiveRecording",
|
|
"parameters": [
|
|
{
|
|
"name": "recordingName",
|
|
"description": "The name of the recording",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"allowMultiple": false,
|
|
"dataType": "string"
|
|
}
|
|
],
|
|
"errorResponses": [
|
|
{
|
|
"code": 404,
|
|
"reason": "Recording not found"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"httpMethod": "DELETE",
|
|
"summary": "Stop a live recording and discard it.",
|
|
"nickname": "cancel",
|
|
"responseClass": "void",
|
|
"parameters": [
|
|
{
|
|
"name": "recordingName",
|
|
"description": "The name of the recording",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"allowMultiple": false,
|
|
"dataType": "string"
|
|
}
|
|
],
|
|
"errorResponses": [
|
|
{
|
|
"code": 404,
|
|
"reason": "Recording not found"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/recordings/live/{recordingName}/stop",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "POST",
|
|
"summary": "Stop a live recording and store it.",
|
|
"nickname": "stop",
|
|
"responseClass": "void",
|
|
"parameters": [
|
|
{
|
|
"name": "recordingName",
|
|
"description": "The name of the recording",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"allowMultiple": false,
|
|
"dataType": "string"
|
|
}
|
|
],
|
|
"errorResponses": [
|
|
{
|
|
"code": 404,
|
|
"reason": "Recording not found"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/recordings/live/{recordingName}/pause",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "POST",
|
|
"summary": "Pause a live recording.",
|
|
"notes": "Pausing a recording suspends silence detection, which will be restarted when the recording is unpaused. Paused time is not included in the accounting for maxDurationSeconds.",
|
|
"nickname": "pause",
|
|
"responseClass": "void",
|
|
"parameters": [
|
|
{
|
|
"name": "recordingName",
|
|
"description": "The name of the recording",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"allowMultiple": false,
|
|
"dataType": "string"
|
|
}
|
|
],
|
|
"errorResponses": [
|
|
{
|
|
"code": 404,
|
|
"reason": "Recording not found"
|
|
},
|
|
{
|
|
"code": 409,
|
|
"reason": "Recording not in session"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"httpMethod": "DELETE",
|
|
"summary": "Unpause a live recording.",
|
|
"nickname": "unpause",
|
|
"responseClass": "void",
|
|
"parameters": [
|
|
{
|
|
"name": "recordingName",
|
|
"description": "The name of the recording",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"allowMultiple": false,
|
|
"dataType": "string"
|
|
}
|
|
],
|
|
"errorResponses": [
|
|
{
|
|
"code": 404,
|
|
"reason": "Recording not found"
|
|
},
|
|
{
|
|
"code": 409,
|
|
"reason": "Recording not in session"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/recordings/live/{recordingName}/mute",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "POST",
|
|
"summary": "Mute a live recording.",
|
|
"notes": "Muting a recording suspends silence detection, which will be restarted when the recording is unmuted.",
|
|
"nickname": "mute",
|
|
"responseClass": "void",
|
|
"parameters": [
|
|
{
|
|
"name": "recordingName",
|
|
"description": "The name of the recording",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"allowMultiple": false,
|
|
"dataType": "string"
|
|
}
|
|
],
|
|
"errorResponses": [
|
|
{
|
|
"code": 404,
|
|
"reason": "Recording not found"
|
|
},
|
|
{
|
|
"code": 409,
|
|
"reason": "Recording not in session"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"httpMethod": "DELETE",
|
|
"summary": "Unmute a live recording.",
|
|
"nickname": "unmute",
|
|
"responseClass": "void",
|
|
"parameters": [
|
|
{
|
|
"name": "recordingName",
|
|
"description": "The name of the recording",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"allowMultiple": false,
|
|
"dataType": "string"
|
|
}
|
|
],
|
|
"errorResponses": [
|
|
{
|
|
"code": 404,
|
|
"reason": "Recording not found"
|
|
},
|
|
{
|
|
"code": 409,
|
|
"reason": "Recording not in session"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"models": {
|
|
"StoredRecording": {
|
|
"id": "StoredRecording",
|
|
"description": "A past recording that may be played back.",
|
|
"properties": {
|
|
"name": {
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"format": {
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"LiveRecording": {
|
|
"id": "LiveRecording",
|
|
"description": "A recording that is in progress",
|
|
"properties": {
|
|
"name": {
|
|
"required": true,
|
|
"type": "string",
|
|
"description": "Base name for the recording"
|
|
},
|
|
"format": {
|
|
"required": true,
|
|
"type": "string",
|
|
"description": "Recording format (wav, gsm, etc.)"
|
|
},
|
|
"state": {
|
|
"required": false,
|
|
"type": "string",
|
|
"allowableValues": {
|
|
"valueType": "LIST",
|
|
"values": [
|
|
"queued",
|
|
"recording",
|
|
"paused",
|
|
"done",
|
|
"failed",
|
|
"canceled"
|
|
]
|
|
}
|
|
},
|
|
"state": {
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
"format": {
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|