ARI: Update version to 1.7.0
[asterisk/asterisk.git] / rest-api / api-docs / sounds.json
1 {
2         "_copyright": "Copyright (C) 2012 - 2013, Digium, Inc.",
3         "_author": "David M. Lee, II <dlee@digium.com>",
4         "_svn_revision": "$Revision$",
5         "apiVersion": "1.7.0",
6         "swaggerVersion": "1.1",
7         "basePath": "http://localhost:8088/ari",
8         "resourcePath": "/api-docs/sounds.{format}",
9         "apis": [
10                 {
11                         "path": "/sounds",
12                         "description": "Sounds",
13                         "operations": [
14                                 {
15                                         "httpMethod": "GET",
16                                         "summary": "List all sounds.",
17                                         "nickname": "list",
18                                         "responseClass": "List[Sound]",
19                                         "parameters": [
20                                                 {
21                                                         "name": "lang",
22                                                         "description": "Lookup sound for a specific language.",
23                                                         "paramType": "query",
24                                                         "dataType": "string",
25                                                         "required": false
26                                                 },
27                                                 {
28                                                         "name": "format",
29                                                         "description": "Lookup sound in a specific format.",
30                                                         "paramType": "query",
31                                                         "dataType": "string",
32                                                         "required": false,
33                                                         "__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."
34                                                 }
35                                         ]
36                                 }
37                         ]
38                 },
39                 {
40                         "path": "/sounds/{soundId}",
41                         "description": "Individual sound",
42                         "operations": [
43                                 {
44                                         "httpMethod": "GET",
45                                         "summary": "Get a sound's details.",
46                                         "nickname": "get",
47                                         "responseClass": "Sound",
48                                         "parameters": [
49                                                 {
50                                                         "name": "soundId",
51                                                         "description": "Sound's id",
52                                                         "paramType": "path",
53                                                         "required": true,
54                                                         "allowMultiple": false,
55                                                         "dataType": "string"
56                                                 }
57                                         ]
58                                 }
59                         ]
60                 }
61         ],
62         "models": {
63                 "FormatLangPair": {
64                         "id": "FormatLangPair",
65                         "description": "Identifies the format and language of a sound file",
66                         "properties": {
67                                 "language": {
68                                         "required": true,
69                                         "type": "string"
70                                 },
71                                 "format": {
72                                         "required": true,
73                                         "type": "string"
74                                 }
75                         }
76                 },
77                 "Sound": {
78                         "id": "Sound",
79                         "description": "A media file that may be played back.",
80                         "properties": {
81                                 "id": {
82                                         "required": true,
83                                         "description": "Sound's identifier.",
84                                         "type": "string"
85                                 },
86                                 "text": {
87                                         "required": false,
88                                         "description": "Text description of the sound, usually the words spoken.",
89                                         "type": "string"
90                                 },
91                                 "formats": {
92                                         "required": true,
93                                         "description": "The formats and languages in which this sound is available.",
94                                         "type": "List[FormatLangPair]"
95                                 }
96                         }
97                 }
98         }
99 }