Files
asterisk/rest-api/api-docs/sounds.json
Matthew Jordan 6107712857 AMI/ARI: Update version numbers
Update the semantic versioning of ARI to 1.3.0 and AMI to 2.3.0 to account for
backwards compatible changes going from 12.2.0 to 12.3.0.
........

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


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@414766 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2014-05-28 17:46:37 +00:00

100 lines
2.4 KiB
JSON

{
"_copyright": "Copyright (C) 2012 - 2013, Digium, Inc.",
"_author": "David M. Lee, II <dlee@digium.com>",
"_svn_revision": "$Revision$",
"apiVersion": "1.3.0",
"swaggerVersion": "1.1",
"basePath": "http://localhost:8088/stasis",
"resourcePath": "/api-docs/sounds.{format}",
"apis": [
{
"path": "/sounds",
"description": "Sounds",
"operations": [
{
"httpMethod": "GET",
"summary": "List all sounds.",
"nickname": "list",
"responseClass": "List[Sound]",
"parameters": [
{
"name": "lang",
"description": "Lookup sound for a specific language.",
"paramType": "query",
"dataType": "string",
"required": false
},
{
"name": "format",
"description": "Lookup sound in a specific format.",
"paramType": "query",
"dataType": "string",
"required": false,
"__note": "core show translation can show translation paths between formats, along with relative costs. so this could be just installed format, or we could follow that for transcoded formats."
}
]
}
]
},
{
"path": "/sounds/{soundId}",
"description": "Individual sound",
"operations": [
{
"httpMethod": "GET",
"summary": "Get a sound's details.",
"nickname": "get",
"responseClass": "Sound",
"parameters": [
{
"name": "soundId",
"description": "Sound's id",
"paramType": "path",
"required": true,
"allowMultiple": false,
"dataType": "string"
}
]
}
]
}
],
"models": {
"FormatLangPair": {
"id": "FormatLangPair",
"description": "Identifies the format and language of a sound file",
"properties": {
"language": {
"required": true,
"type": "string"
},
"format": {
"required": true,
"type": "string"
}
}
},
"Sound": {
"id": "Sound",
"description": "A media file that may be played back.",
"properties": {
"id": {
"required": true,
"description": "Sound's identifier.",
"type": "string"
},
"text": {
"required": false,
"description": "Text description of the sound, usually the words spoken.",
"type": "string"
},
"formats": {
"required": true,
"description": "The formats and languages in which this sound is available.",
"type": "List[FormatLangPair]"
}
}
}
}
}