50
50
type : string
51
51
description : >-
52
52
The value can be either the API id (e.g. "27a5b60716c3a401f2c021a5b718c5b1")
53
- or the slug name (e.g. "mygene"). You can also pass "all" to get a list of
54
- all API metadata (using "from" and "size" for pagination).
53
+ or the slug name (e.g. "mygene"). You can also pass "all" to get a list of
54
+ all API metadata (using "from" and "size" for pagination).
55
55
- name : meta
56
56
in : query
57
57
schema :
@@ -208,7 +208,7 @@ paths:
208
208
description : The object type of the association, e.g. ChemicalSubstance
209
209
example : ChemicalSubstance
210
210
- in : query
211
- name : predicate
211
+ name : predicate
212
212
schema :
213
213
type : string
214
214
description : The predicate of the association, e.g. Gene
@@ -225,8 +225,60 @@ paths:
225
225
type : string
226
226
description : The data source providing the association, e.g. drugbank
227
227
example : drugbank
228
+ - in : query
229
+ name : size
230
+ schema :
231
+ type : integer
232
+ description : The size limit for graphml export
233
+ example : 5000
234
+ - in : query
235
+ name : download
236
+ schema :
237
+ type : boolean
238
+ description : Download option
239
+ example : true
240
+ - in : query
241
+ name : expand
242
+ schema :
243
+ type : array
244
+ items :
245
+ type : string
246
+ enum : ["subject", "object", "predicate", "node", "edge", "all"]
247
+ description : Expand options
248
+ example : ["subject"]
249
+ - in : query
250
+ name : default_view
251
+ schema :
252
+ type : string
253
+ enum : ["json", "cytoscape"]
254
+ description : Default view option
255
+ example : " cytoscape"
256
+ - in : query
257
+ name : header
258
+ schema :
259
+ type : boolean
260
+ description : Header option
261
+ example : true
262
+ - in : query
263
+ name : consolidated
264
+ schema :
265
+ type : boolean
266
+ description : Consolidated option
267
+ example : true
268
+ - in : query
269
+ name : api_details
270
+ schema :
271
+ type : boolean
272
+ description : API details option
273
+ example : false
274
+ - in : query
275
+ name : bte
276
+ schema :
277
+ type : boolean
278
+ description : BTE option
279
+ example : false
228
280
responses :
229
- ' 200 ' :
281
+ ' 200 ' :
230
282
description : Association information including subject, object, predicate, api, provided_by and smartapi info.
231
283
content :
232
284
application/json :
@@ -276,3 +328,106 @@ paths:
276
328
type : string
277
329
description : unique smartapi id for the api
278
330
example : 8f08d1446e0bb9c2b323713ce83e2bd3
331
+ /metakg/paths/ :
332
+ get :
333
+ summary : Query paths in a knowledge graph using MetaKGPathFinder
334
+ parameters :
335
+ - in : query
336
+ name : subject
337
+ schema :
338
+ type : string
339
+ required : true
340
+ description : The subject entity in the knowledge graph
341
+ example : " ExampleSubject"
342
+ - in : query
343
+ name : object
344
+ schema :
345
+ type : string
346
+ required : true
347
+ description : The object entity in the knowledge graph
348
+ example : " ExampleObject"
349
+ - in : query
350
+ name : predicate
351
+ schema :
352
+ ty pe : array
353
+ items :
354
+ type : string
355
+ description : The predicates to consider in the path
356
+ example : ["ExamplePredicate1", "ExamplePredicate2"]
357
+ - in : query
358
+ name : cutoff
359
+ schema :
360
+ type : integer
361
+ description : The maximum length of the paths to retrieve
362
+ example : 3
363
+ - in : query
364
+ name : api_details
365
+ schema :
366
+ type : boolean
367
+ description : Whether to include API details in the response
368
+ example : false
369
+ - in : query
370
+ name : rawquery
371
+ schema :
372
+ type : boolean
373
+ description : Whether to perform a raw query
374
+ example : false
375
+ - in : query
376
+ name : bte
377
+ schema :
378
+ type : boolean
379
+ description : Whether to use the BioThings Explorer
380
+ example : false
381
+ - in : query
382
+ name : expand
383
+ schema :
384
+ type : array
385
+ items :
386
+ type : string
387
+ enum : ["subject", "object", "predicate", "node", "edge", "all"]
388
+ description : The parts of the knowledge graph to expand
389
+ example : ["subject"]
390
+ responses :
391
+ ' 200 ' :
392
+ description : The paths in the knowledge graph
393
+ content :
394
+ application/json :
395
+ schema :
396
+ type : object
397
+ properties :
398
+ paths :
399
+ type : array
400
+ items :
401
+ type : object
402
+ properties :
403
+ path :
404
+ type : array
405
+ items :
406
+ type : string
407
+ edges :
408
+ type : array
409
+ items :
410
+ type : object
411
+ properties :
412
+ subject :
413
+ type : string
414
+ object :
415
+ type : string
416
+ predicate :
417
+ type : string
418
+ api :
419
+ type : array
420
+ items :
421
+ type : object
422
+ properties :
423
+ api :
424
+ type : object
425
+ properties :
426
+ name :
427
+ type : string
428
+ smartapi :
429
+ type : object
430
+ properties :
431
+ id :
432
+ type : string
433
+
0 commit comments