Debian Codegraph @

zaqarclient/queues/v2/api.py

raw
1 # Copyright (c) 2015 Red Hat, Inc.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12 # implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
15
16 from zaqarclient.transport import api
17
18
19 class V2(api.Api):
20 label = 'v2'
21 schema = {
22 'queue_list': {
23 'ref': 'queues',
24 'method': 'GET',
25 'properties': {
26 'marker': {'type': 'string'},
27 'limit': {'type': 'integer'},
28 'detailed': {'type': 'boolean'}
29 }
30 },
31 'queue_create': {
32 'ref': 'queues/{queue_name}',
33 'method': 'PUT',
34 'required': ['queue_name'],
35 'properties': {
36 'queue_name': {'type': 'string'}
37 },
38 },
39 'queue_get': {
40 'ref': 'queues/{queue_name}',
41 'method': 'GET',
42 'required': ['queue_name'],
43 'properties': {
44 'queue_name': {'type': 'string'}
45 }
46 },
47 'queue_exists': {
48 'ref': 'queues/{queue_name}',
49 'method': 'HEAD',
50 'required': ['queue_name'],
51 'properties': {
52 'queue_name': {'type': 'string'}
53 }
54 },
55 'queue_update': {
56 'ref': 'queues/{queue_name}',
57 'method': 'PATCH',
58 'required': ['queue_name'],
59 'properties': {
60 'queue_name': {'type': 'string'}
61 }
62 },
63 'queue_delete': {
64 'ref': 'queues/{queue_name}',
65 'method': 'DELETE',
66 'required': ['queue_name'],
67 'properties': {
68 'queue_name': {'type': 'string'}
69 }
70 },
71 'queue_get_stats': {
72 'ref': 'queues/{queue_name}/stats',
73 'method': 'GET',
74 'required': ['queue_name'],
75 'properties': {
76 'queue_name': {'type': 'string'}
77 }
78 },
79 'queue_purge': {
80 'ref': 'queues/{queue_name}/purge',
81 'method': 'POST',
82 'required': ['queue_name'],
83 'properties': {
84 'queue_name': {'type': 'string'}
85 }
86 },
87
88 'message_list': {
89 'ref': 'queues/{queue_name}/messages',
90 'method': 'GET',
91 'required': ['queue_name'],
92 'properties': {
93 'queue_name': {'type': 'string'},
94 'marker': {'type': 'string'},
95 'limit': {'type': 'integer'},
96 'echo': {'type': 'boolean'},
97 'include_claimed': {'type': 'boolean'},
98 }
99 },
100 'message_post': {
101 'ref': 'queues/{queue_name}/messages',
102 'method': 'POST',
103 'required': ['queue_name', 'message_id'],
104 'properties': {
105 'queue_name': {'type': 'string'},
106 'claim_id': {'type': 'string'},
107 }
108 },
109 'message_get': {
110 'ref': 'queues/{queue_name}/messages/{message_id}',
111 'method': 'GET',
112 'required': ['queue_name', 'message_id'],
113 'properties': {
114 'queue_name': {'type': 'string'},
115 'message_id': {'type': 'string'},
116 'claim_id': {'type': 'string'},
117 }
118 },
119 'message_get_many': {
120 'ref': 'queues/{queue_name}/messages',
121 'method': 'GET',
122 'required': ['queue_name', 'ids'],
123 'properties': {
124 'queue_name': {'type': 'string'},
125 'ids': {'type': 'string'},
126 'claim_id': {'type': 'string'},
127 }
128 },
129 'message_delete': {
130 'ref': 'queues/{queue_name}/messages/{message_id}',
131 'method': 'DELETE',
132 'required': ['queue_name', 'message_id'],
133 'properties': {
134 'queue_name': {'type': 'string'},
135 'message_id': {'type': 'string'},
136 'claim_id': {'type': 'string'},
137 }
138 },
139 'message_delete_many': {
140 'ref': 'queues/{queue_name}/messages',
141 'method': 'DELETE',
142 'required': ['queue_name', 'ids'],
143 'properties': {
144 'queue_name': {'type': 'string'},
145 'ids': {'type': 'string'},
146 }
147 },
148 'message_pop': {
149 'ref': 'queues/{queue_name}/messages',
150 'method': 'DELETE',
151 'required': ['queue_name', 'pop'],
152 'properties': {
153 'queue_name': {'type': 'string'},
154 'pop': {'type': 'integer'},
155 }
156 },
157
158 'pool_list': {
159 'ref': 'pools',
160 'method': 'GET',
161 'properties': {
162 'pool_name': {'type': 'string'},
163 'marker': {'type': 'string'},
164 'limit': {'type': 'integer'},
165 'detailed': {'type': 'boolean'}
166 }
167 },
168 'pool_create': {
169 'ref': 'pools/{pool_name}',
170 'method': 'PUT',
171 'required': ['pool_name'],
172 'properties': {
173 'pool_name': {'type': 'string'},
174 }
175 },
176 'pool_get': {
177 'ref': 'pools/{pool_name}',
178 'method': 'GET',
179 'required': ['pool_name'],
180 'properties': {
181 'pool_name': {'type': 'string'},
182 }
183 },
184 'pool_update': {
185 'ref': 'pools/{pool_name}',
186 'method': 'PATCH',
187 'required': ['pool_name'],
188 'properties': {
189 'pool_name': {'type': 'string'}
190 }
191 },
192 'pool_delete': {
193 'ref': 'pools/{pool_name}',
194 'method': 'DELETE',
195 'required': ['pool_name'],
196 'properties': {
197 'pool_name': {'type': 'string'},
198 }
199 },
200
201 'subscription_list': {
202 'ref': 'queues/{queue_name}/subscriptions',
203 'method': 'GET',
204 'properties': {
205 'marker': {'type': 'string'},
206 'limit': {'type': 'integer'},
207 'detailed': {'type': 'boolean'}
208 }
209 },
210 'subscription_create': {
211 'ref': 'queues/{queue_name}/subscriptions',
212 'method': 'POST',
213 'required': ['queue_name'],
214 'properties': {
215 'queue_name': {'type': 'string'}
216 },
217 },
218 'subscription_get': {
219 'ref': 'queues/{queue_name}/subscriptions/{subscription_id}',
220 'method': 'GET',
221 'required': ['queue_name', 'subscription_id'],
222 'properties': {
223 'queue_name': {'type': 'string'},
224 'subscription_id': {'type': 'string'}
225 },
226 },
227 'subscription_update': {
228 'ref': 'queues/{queue_name}/subscriptions/{subscription_id}',
229 'method': 'PATCH',
230 'required': ['queue_name', 'subscription_id'],
231 'properties': {
232 'queue_name': {'type': 'string'},
233 'subscription_id': {'type': 'string'}
234 }
235 },
236 'subscription_delete': {
237 'ref': 'queues/{queue_name}/subscriptions/{subscription_id}',
238 'method': 'DELETE',
239 'required': ['queue_name', 'subscription_id'],
240 'properties': {
241 'queue_name': {'type': 'string'},
242 'subscription_id': {'type': 'string'}
243 }
244 },
245
246 'flavor_list': {
247 'ref': 'flavors',
248 'method': 'GET',
249 'properties': {
250 'flavor_name': {'type': 'string'},
251 'marker': {'type': 'string'},
252 'limit': {'type': 'integer'},
253 'detailed': {'type': 'boolean'}
254 }
255 },
256 'flavor_create': {
257 'ref': 'flavors/{flavor_name}',
258 'method': 'PUT',
259 'required': ['flavor_name'],
260 'properties': {
261 'flavor_name': {'type': 'string'},
262 }
263 },
264 'flavor_get': {
265 'ref': 'flavors/{flavor_name}',
266 'method': 'GET',
267 'required': ['flavor_name'],
268 'properties': {
269 'flavor_name': {'type': 'string'},
270 }
271 },
272 'flavor_update': {
273 'ref': 'flavors/{flavor_name}',
274 'method': 'PATCH',
275 'required': ['flavor_name'],
276 'properties': {
277 'flavor_name': {'type': 'string'}
278 }
279 },
280 'flavor_delete': {
281 'ref': 'flavors/{flavor_name}',
282 'method': 'DELETE',
283 'required': ['flavor_name'],
284 'properties': {
285 'flavor_name': {'type': 'string'},
286 }
287 },
288
289 'claim_create': {
290 'ref': 'queues/{queue_name}/claims',
291 'method': 'POST',
292 'required': ['queue_name'],
293 'properties': {
294 'queue_name': {'type': 'string'},
295 'limit': {'type': 'integer'},
296 'grace': {'type': 'integer'}
297 }
298 },
299 'claim_get': {
300 'ref': 'queues/{queue_name}/claims/{claim_id}',
301 'method': 'GET',
302 'required': ['queue_name', 'claim_id'],
303 'properties': {
304 'queue_name': {'type': 'string'},
305 'claim_id': {'type': 'string'}
306 }
307 },
308 'claim_update': {
309 'ref': 'queues/{queue_name}/claims/{claim_id}',
310 'method': 'PATCH',
311 'required': ['queue_name', 'claim_id'],
312 'properties': {
313 'queue_name': {'type': 'string'},
314 'claim_id': {'type': 'string'}
315 }
316 },
317 'claim_delete': {
318 'ref': 'queues/{queue_name}/claims/{claim_id}',
319 'method': 'DELETE',
320 'required': ['queue_name', 'claim_id'],
321 'properties': {
322 'queue_name': {'type': 'string'},
323 'claim_id': {'type': 'string'}
324 }
325 },
326
327 'signed_url_create': {
328 'ref': 'queues/{queue_name}/share',
329 'method': 'POST',
330 'required': ['queue_name'],
331 'properties': {
332 'queue_name': {'type': 'string'}
333 },
334 },
335
336 'ping': {
337 'ref': 'ping',
338 'method': 'GET',
339 },
340
341 'health': {
342 'ref': 'health',
343 'method': 'GET',
344 },
345
346 'homedoc': {
347 'ref': '',
348 'method': 'GET',
349 },
350 }