Skip to content

Commit d2f5f35

Browse files
authored
Merge pull request #6 from kevinxin90/master
update smartapi spec to include /metakg endpoint
2 parents 4737da7 + 02f6832 commit d2f5f35

File tree

1 file changed

+85
-0
lines changed

1 file changed

+85
-0
lines changed

SmartAPI/smartapi_openapi.yml

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,3 +185,88 @@ paths:
185185
responses:
186186
default:
187187
description: Default response
188+
/metakg:
189+
get:
190+
summary: retrieve associations within smartapi, if no parameters provided, will return all associations
191+
parameters:
192+
- in: query
193+
name: subject
194+
schema:
195+
type: string
196+
description: The subject type of the association, e.g. Gene
197+
example: Gene
198+
- in: query
199+
name: object
200+
schema:
201+
type: string
202+
description: The object type of the association, e.g. ChemicalSubstance
203+
example: ChemicalSubstance
204+
- in: query
205+
name: predicate
206+
schema:
207+
type: string
208+
description: The predicate of the association, e.g. Gene
209+
example: physically_interacts_with
210+
- in: query
211+
name: api
212+
schema:
213+
type: string
214+
description: The API providing the association, e.g. MyChem.info API
215+
example: MyChem.info API
216+
- in: query
217+
name: provided_by
218+
schema:
219+
type: string
220+
description: The data source providing the association, e.g. drugbank
221+
example: drugbank
222+
responses:
223+
'200':
224+
description: Association information including subject, object, predicate, api, provided_by and smartapi info.
225+
content:
226+
application/json:
227+
schema:
228+
description: Array of all associations
229+
type: array
230+
items:
231+
type: object
232+
properties:
233+
subject:
234+
type: string
235+
description: The subject type of the association, e.g. Gene
236+
example: Gene
237+
object:
238+
type: string
239+
description: The object type of the association, e.g. ChemicalSubstance
240+
example: ChemicalSubstance
241+
predicate:
242+
type: string
243+
description: The predicate of the association, e.g. physically_interacts_with
244+
example: physically_interacts_with
245+
provided_by:
246+
type: string
247+
description: The data source providing the association, e.g. ChEMBL
248+
example: ChEMBL
249+
api:
250+
type: object
251+
description: The api providing the association, e.g. MyChem.info
252+
properties:
253+
name:
254+
type: string
255+
description: The api providing the association, e.g. MyChem.info
256+
example: MyChem.info API
257+
smartapi:
258+
type: object
259+
description: smartapi related data
260+
properties:
261+
metadata:
262+
type: string
263+
description: the url for smartapi specification
264+
example: https://raw.githubusercontent.com/NCATS-Tangerine/translator-api-registry/master/mychem.info/openapi_full.yml
265+
ui:
266+
type: string
267+
description: the web UI url for the API
268+
example: https://smart-api.info/ui/8f08d1446e0bb9c2b323713ce83e2bd3
269+
id:
270+
type: string
271+
description: unique smartapi id for the api
272+
example: 8f08d1446e0bb9c2b323713ce83e2bd3

0 commit comments

Comments
 (0)