-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
475 lines (466 loc) · 13.3 KB
/
openapi.yaml
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
openapi: 3.0.1
info:
version: 1.0.0
description: An API to control a Firefox browser instance
title: Autobrowser
servers:
- url: https://localhost
description: Local server
paths:
/closeTabById:
post:
summary: Close a tab by its ID. Tab IDs can be found in the /tabsList endpoint, they are also returned by the /openTab endpoint
requestBody:
content:
application/json:
schema:
properties:
tab_id:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
status:
type: string
enum: ['success']
message:
type: string
enum: ['OK']
'408':
description: Timeout error
content:
application/json:
schema:
properties:
status:
type: string
enum: ['error']
mesage:
type: string
enum: ['timeout']
'400':
description: Unknown server error - see message for details
content:
application/json:
schema:
properties:
status:
type: string
enum: ['error']
message:
type: string
/tabsList:
get:
summary: Get list of tabs
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
status:
type: string
enum: ['success']
message:
type: string
enum: ['OK']
result:
type: array
items:
type: object
properties:
id:
type: integer
url:
type: string
title:
type: string
'408':
description: Timeout error
content:
application/json:
schema:
properties:
status:
type: string
enum: ['error']
message:
type: string
enum: ['Timeout waiting for tabsList']
result:
type: string
enum: ['timeout']
'400'
description: Error
content:
application/json:
schema:
properties:
status:
type: string
enum: ['error']
message:
type: string
result:
type: boolean
enum: [false]
/openTab:
post:
summary: Open a new tab
requestBody:
content:
application/json:
schema:
properties:
url:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
status:
type: string
enum: ['success']
message:
type: string
result:
type: integer
'400':
description: Error
content:
application/json:
schema:
properties:
status:
type: string
enum: ['error']
message:
type: string
result:
type: boolean
enum: [false]
'408':
description: Timeout error
content:
application/json:
schema:
properties:
status:
type: string
enum: ['error']
message:
type: string
enum: ['Timeout waiting for openTab']
result:
type: string
enum: ['timeout']
/injectScript:
post:
summary: Inject a script
requestBody:
content:
application/json:
schema:
properties:
tab_id:
type: string
code:
type: string
timeout:
type: integer
responses:
'200':
description: OK - this return code means only that the script was successfully injected, any errors raised by the script in the browser are also returned under this code.
content:
application/json:
schema:
properties:
status:
type: string
enum: ['success']
message:
type: string
result:
type: string
'400':
description: Error - this signals an error with script injection, not an error caused by the execution of the injected script.
content:
application/json:
schema:
properties:
status:
type: string
enum: ['error']
message:
type: string
result:
type: boolean
enum: [false]
'408':
description: Timeout error
content:
application/json:
schema:
properties:
status:
type: string
enum: ['error']
message:
type: string
enum: ['Timeout waiting for injectScript']
result:
type: string
enum: ['timeout']
'500':
description: An unknown server error
content:
application/json:
schema:
properties:
status:
type: string
enum: ['error']
message:
type: string
enum: ['Unknown server error occured. Failed to receive a result from the browser.']
result:
type: boolean
enum: [false]
/waitForElement:
post:
summary: Wait for an element to become available in the page's DOM
requestBody:
content:
application/json:
schema:
properties:
tab_id:
type: integer
selector:
description: This is a CSS Path selector that can be used with document.querySelector()
type: string
timeout:
description: Amount of time (in seconds) to wait for the element to become available
type: integer
default: 60
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
status:
type: string
enum: ['success']
message:
type: string
result:
type: boolean
enum: [true]
'400':
description: Error
content:
application/json:
schema:
properties:
status:
type: string
enum: ['error']
message:
type: string
result:
type: boolean
enum: [false]
'408':
description: Timeout error
content:
application/json:
schema:
properties:
status:
type: string
enum: ['error']
message:
type: string
enum: ['Timeout waiting for waitForElement']
result:
type: string
enum: ['timeout']
/getTabHTML/{tab_id}:
get:
summary: Get HTML of a tab
parameters:
- name: tab_id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
status:
type: string
enum: ['success']
message:
type: string
result:
type: string
'400':
description: Error
content:
application/json:
schema:
properties:
status:
type: string
enum: ['error']
message:
type: string
result:
type: boolean
enum: [false]
'408':
description: Timeout error
content:
application/json:
schema:
properties:
status:
type: string
enum: ['error']
message:
type: string
enum: ['Timeout waiting for getTabHTML']
result:
type: string
enum: ['timeout']
/health:
get:
summary: Health check
responses:
'200':
description: The service is up and running
content:
application/json:
schema:
properties:
status:
type: string
enum: ['success']
message:
type: string
result:
type: boolean
enum: [true]
/openUrl:
post:
summary: Open a URL in a tab with the provided tab ID.
requestBody:
content:
application/json:
schema:
properties:
tab_id:
type: integer
url:
type: string
timeout:
type: integer
default: 60
responses:
'200':
description: Successfully opened the URL.
content:
application/json:
schema:
$ref: '#/components/schemas/BasicSuccess'
'408':
description: Timeout reached when trying to open the URL
content:
application/json:
schema:
$ref: '#/components/schemas/TimeoutError'
'400':
description: There is a problem with the request
content:
application/json:
schema:
oneOf:
$ref: '#/components/schemas/TabNotFoundError'
$ref: '#/components/schemas/ArgumentTypeError'
components:
schemas:
BasicSuccess:
type: object
properties:
status:
type: string
enum: ['success']
result:
type: boolean
enum: [true]
message:
type: string
enum: ['OK']
BasicError:
type: object
properties:
status:
type: string
enum: ['error']
result:
type: boolean
enum: [false]
UnknownServerError:
allOf:
- $ref: '#/components/schemas/BasicError'
- type: object
properties:
message:
type: string
enum: ['Unknown server error occured.']
TabNotFoundError:
allOf:
- $ref: '#/components/schemas/BasicError'
- type: object
properties:
message:
type: string
enum: ['No tab with given ID was found']
ArgumentTypeError:
allOf:
- $ref: '#/components/schemas/BasicError'
- type: object
properties:
message:
type: string
enum: ['Invalid argument type']
PageNotFoundError:
allOf:
- $ref: '#/components/schemas/BasicError'
- type: object
properties:
message:
type: string
enum: ['URL not found']
TimeoutError:
allOf:
- $ref: '#/components/schemas/BasicError'
- type: object
properties:
message:
type: string
enum: ['Timeout reached while waiting for response']