Skip to content

Commit 7d85e88

Browse files
committed
moved resposnes into components for cleaner code
1 parent f17e729 commit 7d85e88

File tree

1 file changed

+79
-92
lines changed

1 file changed

+79
-92
lines changed

SmartAPI/smartapi_openapi.yml

Lines changed: 79 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ paths:
9696
description: >-
9797
The number of items returned in one request. Combining with "from"
9898
parameter, this can be used for the pagination of the long result.
99-
operationId: ''
99+
operationId: apiGetMetadata
100100
responses:
101101
"200":
102102
description: successful response
@@ -163,7 +163,7 @@ paths:
163163
description: >-
164164
The full URL of an input SmartAPI metadata to validate. The file
165165
format can be either JSON or YAML.
166-
operationId: ''
166+
operationId: 'validateGet'
167167
responses:
168168
'200':
169169
description: default response
@@ -187,7 +187,7 @@ paths:
187187
schema:
188188
type: string
189189
description: The maximum number of suggested values to return
190-
operationId: ''
190+
operationId: suggestGet
191191
responses:
192192
default:
193193
description: Default response
@@ -278,56 +278,12 @@ paths:
278278
description: BTE option
279279
example: false
280280
responses:
281-
'200':
281+
'200':
282282
description: Association information including subject, object, predicate, api, provided_by and smartapi info.
283283
content:
284284
application/json:
285285
schema:
286-
description: Array of all associations
287-
type: array
288-
items:
289-
type: object
290-
properties:
291-
subject:
292-
type: string
293-
description: The subject type of the association, e.g. Gene
294-
example: Gene
295-
object:
296-
type: string
297-
description: The object type of the association, e.g. ChemicalSubstance
298-
example: ChemicalSubstance
299-
predicate:
300-
type: string
301-
description: The predicate of the association, e.g. physically_interacts_with
302-
example: physically_interacts_with
303-
provided_by:
304-
type: string
305-
description: The data source providing the association, e.g. ChEMBL
306-
example: ChEMBL
307-
api:
308-
type: object
309-
description: The api providing the association, e.g. MyChem.info
310-
properties:
311-
name:
312-
type: string
313-
description: The api providing the association, e.g. MyChem.info
314-
example: MyChem.info API
315-
smartapi:
316-
type: object
317-
description: smartapi related data
318-
properties:
319-
metadata:
320-
type: string
321-
description: the url for smartapi specification
322-
example: https://raw.githubusercontent.com/NCATS-Tangerine/translator-api-registry/master/mychem.info/openapi_full.yml
323-
ui:
324-
type: string
325-
description: the web UI url for the API
326-
example: https://smart-api.info/ui/8f08d1446e0bb9c2b323713ce83e2bd3
327-
id:
328-
type: string
329-
description: unique smartapi id for the api
330-
example: 8f08d1446e0bb9c2b323713ce83e2bd3
286+
$ref: '#/components/schemas/MetakgResponse'
331287
/metakg/paths/:
332288
get:
333289
summary: Query paths in a knowledge graph using MetaKGPathFinder
@@ -349,7 +305,7 @@ paths:
349305
- in: query
350306
name: predicate
351307
schema:
352-
ty pe: array
308+
type: array
353309
items:
354310
type: string
355311
description: The predicates to consider in the path
@@ -387,47 +343,78 @@ paths:
387343
enum: ["subject", "object", "predicate", "node", "edge", "all"]
388344
description: The parts of the knowledge graph to expand
389345
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:
346+
responses:
347+
'200':
348+
description: The paths in the knowledge graph
349+
content:
350+
application/json:
351+
schema:
352+
$ref: '#/components/schemas/PathsResponse'
353+
components:
354+
schemas:
355+
MetakgResponse:
356+
description: Array of all associations
357+
type: array
358+
items:
359+
type: object
360+
properties:
361+
subject:
362+
type: string
363+
object:
364+
type: string
365+
predicate:
366+
type: string
367+
provided_by:
368+
type: string
369+
api:
370+
type: object
371+
properties:
372+
name:
373+
type: string
374+
smartapi:
375+
type: object
376+
properties:
377+
metadata:
378+
type: string
379+
ui:
380+
type: string
381+
id:
382+
type: string
383+
PathsResponse:
384+
type: object
385+
properties:
386+
paths:
387+
type: array
388+
items:
389+
type: object
390+
properties:
391+
path:
392+
type: array
393+
items:
394+
type: string
395+
edges:
396+
type: array
397+
items:
398+
type: object
399+
properties:
400+
subject:
401+
type: string
402+
object:
403+
type: string
404+
predicate:
405+
type: string
406+
api:
407+
type: array
408+
items:
409+
type: object
410+
properties:
411+
api:
412+
type: object
413+
properties:
414+
name:
415+
type: string
416+
smartapi:
421417
type: object
422418
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-
419+
id:
420+
type: string

0 commit comments

Comments
 (0)