forked from intermine/intermine-registry
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.json
621 lines (611 loc) · 17.9 KB
/
swagger.json
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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
{
"swagger": "2.0",
"info": {
"description": "API Documentation for the InterMine Registry RESTful API.",
"version": "1.1.0",
"title": "InterMine Registry",
"license": {
"name": "GNU General Public License v3.0",
"url": "https://www.gnu.org/licenses/gpl-3.0.en.html"
}
},
"host": "registry.intermine.org",
"basePath": "/service",
"tags": [
{
"name": "instance",
"description": "Operations regarding the InterMine Registry instances.",
"externalDocs": {
"description": "Find out more",
"url": "https://github.com/intermine/intermine-registry/"
}
},
{
"name": "synchronize",
"description": "Operations regarding the InterMine Registry instances versions & branding updates.",
"externalDocs": {
"description": "Find out more",
"url": "https://github.com/intermine/intermine-registry/"
}
}
],
"schemes": [
"http"
],
"paths": {
"/instances": {
"post": {
"tags": [
"instances"
],
"summary": "Add an instance to the InterMine Registry.",
"description": "Add a new instance to the InterMine Registry. Name and URL are required. Provided URL is subject to test by doing a ping to the mine /version endpoint.",
"operationId": "addinstances",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Information needed to create an instance on the Registry",
"required": true,
"schema": {
"type": "object",
"required": ["name", "url"],
"properties": {
"name": {
"type": "string",
"example": "FlyMine"
},
"neighbours": {
"items": {
"type": "string"
},
"example": ["MODs"],
"type": "array"
},
"organisms": {
"items": {
"type": "string"
},
"example": ["Drosophila"],
"type": "array"
},
"url": {
"type": "string",
"example": "http://www.flymine.org/query"
},
"description": {
"type": "string",
"example": "FlyMine is an integrated database of genomic, expression and protein data for Drosophila, Anopheles and C. elegans"
},
"location": {
"properties": {
"latitude": {
"type": "string",
"example": "52.2003399"
},
"longitude": {
"type": "string",
"example": "0.120109"
}
},
"type": "object"
},
"twitter": {
"type": "string",
"example": "@intermineorg"
}
}
}
}
],
"responses": {
"201": {
"description": "Instance Successfully Added to the Registry"
},
"401": {
"description": "Authentication information is missing or invalid",
"headers": {
"WWW_Authenticate": {
"type": "string"
}
}
},
"406": {
"description": "Bad Request"
},
"400": {
"description": "Malformed JSON. Invalid or Missing Data. Check for invalid URL."
}
},
"security": [
{
"basicAuth": []
}
]
},
"get": {
"tags": [
"instances"
],
"summary": "Get all InterMine Registry Instances information.",
"description": "Get all Registry Instances which status is Running.",
"operationId": "getAllInstances",
"produces": [
"application/json"
],
"parameters": [
{
"name": "q",
"in": "query",
"description": "A space-delimited list of word to look for in the instance name, organisms or brief description. If not given, all the instances are returned.",
"required": false,
"type": "string"
},
{
"name": "mines",
"in": "query",
"description": "Three possible values: 'dev', 'all' or 'prod'. Retrieves the InterMine instances that are 'development' mines, all the mines or 'production' mines respectively. ",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"schema": {
"items": {
"$ref": "#/definitions/instances"
}
}
},
"404": {
"description": "Instances Not Found"
}
},
"security": [
]
}
},
"/instances/{instanceIdOrName}": {
"get": {
"tags": [
"instances"
],
"summary": "Finds an instance by its ID or Name",
"description": "Get all the information of a given InterMine instance (id or Name).",
"operationId": "findInstanceById",
"produces": [
"application/json"
],
"parameters": [
{
"name": "instanceIdOrName",
"in": "path",
"description": "ID or Name of instance to return",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful Operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/instances"
}
}
},
"404": {
"description": "Instance Not Found"
}
},
"security": [
]
}
},
"/instances/{instancesId}": {
"put": {
"tags": [
"instances"
],
"summary": "Update an instance on the InterMine Registry",
"description": "Update the instance given in the URL on the InterMine Registry.",
"operationId": "updateInstance",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "instancesId",
"in": "path",
"description": "ID of the instance that needs to be updated",
"required": true,
"type": "integer",
"format": "int64"
},
{
"in": "body",
"name": "body",
"description": "Information needed to update an instance on the Registry. Not all the fields are needed.",
"required": true,
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "FlyMine"
},
"neighbours": {
"items": {
"type": "string"
},
"example": ["MODs"],
"type": "array"
},
"organisms": {
"items": {
"type": "string"
},
"example": ["Drosophila"],
"type": "array"
},
"url": {
"type": "string",
"example": "http://www.flymine.org/query"
},
"description": {
"type": "string",
"example": "FlyMine is an integrated database of genomic, expression and protein data for Drosophila, Anopheles and C. elegans"
},
"location": {
"properties": {
"latitude": {
"type": "string",
"example": "52.2003399"
},
"longitude": {
"type": "string",
"example": "0.120109"
}
},
"type": "object"
},
"twitter": {
"type": "string",
"example": "@intermineorg"
}
}
}
}
],
"responses": {
"201": {
"description": "Instance Successfully Updated on the Registry"
},
"400": {
"description": "Malformed JSON. Invalid or Missing Data. Check for invalid URL."
},
"401": {
"description": "Authentication information is missing or invalid",
"headers": {
"WWW_Authenticate": {
"type": "string"
}
}
},
"404": {
"description": "Instance Not Found"
},
"406": {
"description": "Bad Request"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"instances"
],
"summary": "Deletes an instance from the InterMine Registry",
"description": "Delete the instance given in the URL from the registry.",
"operationId": "deleteinstances",
"produces": [
"application/json"
],
"parameters": [
{
"name": "instancesId",
"in": "path",
"description": "Id of the instance to delete",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "Instance Successfully Deleted"
},
"401": {
"description": "Authentication information is missing or invalid",
"headers": {
"WWW_Authenticate": {
"type": "string"
}
}
},
"404": {
"description": "Instance Not Found"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/synchronize": {
"put": {
"tags": [
"synchronize"
],
"summary": "Update the branding & version information of every instance on the InterMine Registry",
"description": "Update the branding & version information of every instance on the InterMine Registry. For each instance on the registry we do 4 parallel http requests to the branding & version endpoints to verify if they have been updated.",
"operationId": "synchronizeInstances",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Instance Version & Branding Successfully Updated on the InterMine Registry"
},
"401": {
"description": "Authentication information is missing or invalid",
"headers": {
"WWW_Authenticate": {
"type": "string"
}
}
},
"406": {
"description": "Bad Request"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/synchronize/{instanceIdOrName}": {
"put": {
"tags": [
"synchronize"
],
"summary": "Update the branding & version information on the InterMine Registry of the specified instance in the URL",
"description": "Update the branding & version information of the instance given in the URL",
"operationId": "synchronizeInstance",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "instanceIdOrName",
"in": "path",
"description": "ID or Name of instance to update",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Instances Versions & Branding Successfully Updated on the Registry"
},
"401": {
"description": "Authentication information is missing or invalid",
"headers": {
"WWW_Authenticate": {
"type": "string"
}
}
},
"404": {
"description": "Instance Not Found"
},
"406": {
"description": "Bad Request"
}
},
"security": [
{
"basicAuth": []
}
]
}
}
},
"securityDefinitions": {
"basicAuth": {
"type": "basic"
}
},
"definitions": {
"instances": {
"type": "object",
"required": ["name", "url"],
"properties": {
"name": {
"type": "string",
"example": "FlyMine"
},
"api_version": {
"type": "string",
"example": "19"
},
"release_version": {
"type": "string",
"example": "42.1 2016 Jan"
},
"intermine_version": {
"type": "string",
"example": "1.7.1"
},
"neighbours": {
"items": {
"type": "string"
},
"example": ["MODs"],
"type": "array"
},
"organisms": {
"items": {
"type": "string"
},
"example": ["Drosophila"],
"type": "array"
},
"url": {
"type": "string",
"example": "http://www.flymine.org/query"
},
"description": {
"type": "string",
"example": "FlyMine is an integrated database of genomic, expression and protein data for Drosophila, Anopheles and C. elegans"
},
"location": {
"properties": {
"latitude": {
"type": "string",
"example": "52.2003399"
},
"longitude": {
"type": "string",
"example": "0.120109"
}
},
"type": "object"
},
"colors": {
"properties": {
"focus": {
"properties": {
"bg": {
"type": "string",
"example": "#fff"
},
"fg": {
"type": "string",
"example": "#5c0075"
}
},
"type": "object"
},
"main": {
"properties": {
"bg": {
"type": "string",
"example": "#535353"
},
"fg": {
"type": "string",
"example": "#fff"
}
},
"type": "object"
},
"header": {
"properties": {
"text": {
"type": "string",
"example": "#535353"
},
"main": {
"type": "string",
"example": "#fff"
}
},
"type": "object"
}
},
"type": "object"
},
"images": {
"properties": {
"main": {
"type": "string",
"example": "model/images/logo.png"
},
"small": {
"type": "string",
"example": "model/images/logo.png"
},
"logo": {
"type": "string",
"example": "model/images/logo.png"
}
},
"type": "object"
},
"twitter": {
"type": "string",
"example": "@intermineorg"
},
"status": {
"type": "string",
"example": "Running"
}
}
},
"apiResponse": {
"type": "object",
"properties": {
"extraData":{
"items": {
"type": "object"
},
"type": "array"
},
"statusCode": {
"type": "integer",
"format": "int32",
"example": "200"
},
"message": {
"type": "string",
"example": "Instance Successfully Updated"
},
"executionTime": {
"type": "string",
"example": "6/6/2017, 1:42:19 PM"
}
},
"required": ["message", "executionTime", "statusCode"]
}
},
"externalDocs": {
"description": "InterMine Registry GitHub",
"url": "https://github.com/intermine/intermine-registry/"
}
}