aa758781cdd760916d86540323ce169c77e48866
[asterisk/asterisk.git] / rest-api / api-docs / playback.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": "0.0.1",
6         "swaggerVersion": "1.1",
7         "basePath": "http://localhost:8088/stasis",
8         "resourcePath": "/api-docs/playback.{format}",
9         "apis": [
10                 {
11                         "path": "/playback/{playbackId}",
12                         "description": "Control object for a playback operation.",
13                         "operations": [
14                                 {
15                                         "httpMethod": "GET",
16                                         "summary": "Get a playback's details.",
17                                         "nickname": "getPlayback",
18                                         "responseClass": "Playback",
19                                         "parameters": [
20                                                 {
21                                                         "name": "playbackId",
22                                                         "description": "Playback's id",
23                                                         "paramType": "path",
24                                                         "required": true,
25                                                         "allowMultiple": false,
26                                                         "dataType": "string"
27                                                 }
28                                         ]
29                                 },
30                                 {
31                                         "httpMethod": "DELETE",
32                                         "summary": "Stop a playback.",
33                                         "nickname": "stopPlayback",
34                                         "responseClass": "Playback",
35                                         "parameters": [
36                                                 {
37                                                         "name": "playbackId",
38                                                         "description": "Playback's id",
39                                                         "paramType": "path",
40                                                         "required": true,
41                                                         "allowMultiple": false,
42                                                         "dataType": "string"
43                                                 }
44                                         ]
45                                 }
46                         ]
47                 },
48                 {
49                         "path": "/playback/{playbackId}/control",
50                         "description": "Control object for a playback operation.",
51                         "operations": [
52                                 {
53                                         "httpMethod": "POST",
54                                         "summary": "Get a playback's details.",
55                                         "nickname": "controlPlayback",
56                                         "responseClass": "Playback",
57                                         "parameters": [
58                                                 {
59                                                         "name": "playbackId",
60                                                         "description": "Playback's id",
61                                                         "paramType": "path",
62                                                         "required": true,
63                                                         "allowMultiple": false,
64                                                         "dataType": "string"
65                                                 },
66                                                 {
67                                                         "name": "operation",
68                                                         "description": "Operation to perform on the playback.",
69                                                         "paramType": "query",
70                                                         "required": true,
71                                                         "allowMultiple": false,
72                                                         "dataType": "string",
73                                                         "allowableValues": {
74                                                                 "valueType": "LIST",
75                                                                 "values": [
76                                                                         "play",
77                                                                         "pause",
78                                                                         "rewind",
79                                                                         "fast-forward",
80                                                                         "speed-up",
81                                                                         "slow-down"
82                                                                 ]
83                                                         }
84                                                 }
85                                         ]
86                                 }
87                         ]
88                 }
89         ],
90         "models": {
91                 "Playback": {
92                         "id": "Playback",
93                         "properties": {
94                                 "id": {
95                                         "required": true,
96                                         "description": "Playback's identifier.",
97                                         "type": "string"
98                                 }
99                         }
100                 }
101         }
102 }