1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
{
"_copyright": "Copyright (C) 2013, Digium, Inc.",
"_author": "Jonathan Rose <jrose@digium.com>",
"_svn_revision": "$Revision$",
"apiVersion": "1.5.0",
"swaggerVersion": "1.1",
"basePath": "http://localhost:8088/stasis",
"resourcePath": "/api-docs/mailboxes.{format}",
"apis": [
{
"path": "/mailboxes",
"description": "Mailboxes",
"operations": [
{
"httpMethod": "GET",
"summary": "List all mailboxes.",
"nickname": "list",
"responseClass": "List[Mailbox]"
}
]
},
{
"path": "/mailboxes/{mailboxName}",
"description": "Mailbox state",
"operations": [
{
"httpMethod": "GET",
"summary": "Retrieve the current state of a mailbox.",
"nickname": "get",
"responseClass": "Mailbox",
"parameters": [
{
"name": "mailboxName",
"description": "Name of the mailbox",
"paramType": "path",
"required": true,
"allowMultiple": false,
"dataType": "string"
}
],
"errorResponses": [
{
"code": 404,
"reason": "Mailbox not found"
}
]
},
{
"httpMethod": "PUT",
"summary": "Change the state of a mailbox. (Note - implicitly creates the mailbox).",
"nickname": "update",
"responseClass": "void",
"parameters": [
{
"name": "mailboxName",
"description": "Name of the mailbox",
"paramType": "path",
"required": true,
"allowMultiple": false,
"dataType": "string"
},
{
"name": "oldMessages",
"description": "Count of old messages in the mailbox",
"paramType": "query",
"required": true,
"allowMultiple": false,
"dataType": "int"
},
{
"name": "newMessages",
"description": "Count of new messages in the mailbox",
"paramType": "query",
"required": true,
"allowMultiple": false,
"dataType": "int"
}
],
"errorResponses": [
{
"code": 404,
"reason": "Mailbox not found"
}
]
},
{
"httpMethod": "DELETE",
"summary": "Destroy a mailbox.",
"nickname": "delete",
"responseClass": "void",
"parameters": [
{
"name": "mailboxName",
"description": "Name of the mailbox",
"paramType": "path",
"required": true,
"allowMultiple": false,
"dataType": "string"
}
],
"errorResponses": [
{
"code": 404,
"reason": "Mailbox not found"
}
]
}
]
}
],
"models": {
"Mailbox": {
"id": "Mailbox",
"description": "Represents the state of a mailbox.",
"properties": {
"name": {
"type": "string",
"description": "Name of the mailbox.",
"required": true
},
"old_messages": {
"type": "int",
"description": "Count of old messages in the mailbox.",
"required": true
},
"new_messages": {
"type": "int",
"description": "Count of new messages in the mailbox.",
"required": true
}
}
}
}
}
|
