mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-16 09:52:24 +00:00
537ecebd2d
Swagger allows parameters to be specified as 'allowMultiple', meaning that the parameter may be specified as a comma separated list of values. I had written some of the API docs using that, but promptly forgot about implementing it. This patch finally fills in that gap. The codegen template was updated to represent 'allowMultiple' fields as array/size fields in the _args structs. It also parses the comma separated list using ast_app_separate_args(), so quoted strings in the argument will be handled properly. Review: https://reviewboard.asterisk.org/r/2698/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@396122 65c4cc65-6c06-0410-ace0-fbb531ad65f3
100 lines
2.4 KiB
JSON
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": "0.0.1",
|
|
"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": "getSounds",
|
|
"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": "getStoredSound",
|
|
"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]"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|