Skip to content

Commit a61d6f9

Browse files
susrinivasansusrinivasan
authored
Create MetGENEAPI_openapi.yml
This is the open API yml file for MetGENE
1 parent 0fb0846 commit a61d6f9

File tree

1 file changed

+244
-0
lines changed

1 file changed

+244
-0
lines changed

‎MetGENE_API/MetGENEAPI_openapi.yml

Lines changed: 244 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,244 @@
1+
openapi: 3.0.0
2+
info:
3+
title: MetGENE REST API
4+
version: "1.0.0"
5+
description: |
6+
The MetGENE REST service enables access to a variety of data (including reactions, metabolites and studies for a certain gene or list of genes) using HTTP requests. These requests may be carried out using a web browser or may be embedded in 3rd party applications or scripts to enable programmatic access. Most modern programming languages including PHP, Perl, Python, Java and Javascript have the capability to create HTTP request and interact with datasets such as this REST service.
7+
license:
8+
name: Terms of Use
9+
url: https://bdcw.org/MetGENE/termsofuse.php
10+
contact:
11+
name: Contact
12+
url: https://bdcw.org/MetGENE/contact.php
13+
servers:
14+
- description: MetGENE
15+
url: https://bdcw.org/MetGENE/rest
16+
paths:
17+
/reactions/species/{species_id}/GeneIDType/{geneID_type}/GeneInfoStr/{gene_ID}/anatomy/NA/disease/NA/phenotype/NA/viewType/{vtf}:
18+
get:
19+
description: Fetch all the reactions for a given species, gene or list of genes. Anatomy, disease and phenotype inputs are not needed as reactions are not specific for these.
20+
parameters:
21+
- in: path
22+
name: species_id
23+
description: The unique species name or identifier
24+
schema:
25+
type: string
26+
example: hsa
27+
required: true
28+
- in: path
29+
name: geneID_type
30+
description: The unique Gene ID type like ENTREZID, SYMBOL, SYMBOL_OR_ALIAS, UNIPROT, ENSEMBL or REFSEQ
31+
schema:
32+
type: string
33+
example: SYMBOL
34+
required: true
35+
- in: path
36+
name: gene_ID
37+
description: The unigue gene identifier in any one of the known formats or double tab separated list of identifiers
38+
schema:
39+
type: string
40+
example: HK1
41+
required: true
42+
- in: path
43+
name: vtf
44+
description: Media type e.g. json or txt
45+
schema:
46+
type: string
47+
example: json or txt
48+
required: true
49+
responses:
50+
'200':
51+
description: Success
52+
content:
53+
application/json:
54+
schema:
55+
type: object
56+
properties:
57+
Gene:
58+
type: string
59+
description: Entrez Gene ID
60+
KEGG_REACTION_ID:
61+
type: string
62+
description: KEGG Reaction IDs
63+
KEGG_REACTION_NAME:
64+
type: string
65+
description: Verbose KEGG reaction name
66+
text/plain:
67+
schema:
68+
type: string
69+
example: pong
70+
x-responseValueType:
71+
- x-path: gene_id
72+
x-valueType: https://identifiers.org/ncbigene
73+
- x-path: KEGG_REACTION_ID
74+
x-valueType: https://www.genome.jp/kegg/reaction/
75+
- x-path: KEGG_REACTION_NAME
76+
x-valueType: https://www.genome.jp/kegg/reaction/
77+
/metabolites/species/{species_id}/GeneIDType/{geneID_type}/GeneInfoStr/{gene_ID}/anatomy/{anatomy_name}/disease/{disease_name}/phenotype/{phenotype_name}/viewType/{vtf}:
78+
get:
79+
description: Fetch all the metabolites for a given species, gene or list of genes, anatomy or tissue type, disease and phenotype.
80+
parameters:
81+
- in: path
82+
name: species_id
83+
description: The unique species name or identifier like hsa, Human, mmu, Mouse.
84+
schema:
85+
type: string
86+
example: hsa
87+
required: true
88+
- in: path
89+
name: geneID_type
90+
description: The unique Gene ID type like ENTREZID, SYMBOL, SYMBOL_OR_ALIAS, UNIPROT, ENSEMBL or REFSEQ
91+
schema:
92+
type: string
93+
example: SYMBOL
94+
required: true
95+
- in: path
96+
name: gene_ID
97+
description: The unigue gene identifier (e.g. 3098) in any one of the known formats (e.g. ENTREZID ) or double underscore separated list of identifiers (3098__6120)
98+
schema:
99+
type: string
100+
example: HK1
101+
required: true
102+
- in: path
103+
name: anatomy_name
104+
description: The anatomy or tissue name (e.g. Blood, Lung, Liver)
105+
schema:
106+
type: string
107+
example: Blood or NA (for unspecified)
108+
required: true
109+
- in: path
110+
name: disease_name
111+
description: The disease name (e.g. Diabetes, Fatty liver disease)
112+
schema:
113+
type: string
114+
example: Diabetes or NA (for unspecified)
115+
required: true
116+
- in: path
117+
name: phenotype_name
118+
description: The phenotype name (e.g. BMI)
119+
schema:
120+
type: string
121+
example: BMI or NA (for unspecified)
122+
required: true
123+
- in: path
124+
name: vtf
125+
description: Media type e.g. json or txt
126+
schema:
127+
type: string
128+
example: json or txt
129+
required: true
130+
responses:
131+
'200':
132+
description: Success
133+
content:
134+
application/json:
135+
schema:
136+
type: object
137+
properties:
138+
Gene:
139+
type: string
140+
description: Entrez Gene ID
141+
KEGG_COMPOUND_ID:
142+
type: string
143+
description: KEGG Compound IDs
144+
REFMET_NAME:
145+
type: string
146+
description: Metabolomics Workbench RefMet name
147+
KEGG_REACTION_ID:
148+
type: string
149+
description: KEGG Reaction IDs
150+
METSTAT_LINK:
151+
type: string
152+
description: Link to metabolite statistics in Metabolomics Workbench
153+
text/plain:
154+
schema:
155+
type: string
156+
example: pong
157+
x-responseValueType:
158+
- x-path: gene_id
159+
x-valueType: https://identifiers.org/ncbigene
160+
- x-path: KEGG_COMPOUND_ID
161+
x-valueType: https://www.genome.jp/kegg/compound/
162+
- x-path: REFMET_NAME
163+
x-valueType: https://www.metabolomicsworkbench.org/databases/refmet/index.php
164+
- x-path: KEGG_REACTION_ID
165+
x-valueType: https://www.genome.jp/kegg/reaction/
166+
/studies/species/{species_id}/GeneIDType/{geneID_type}/GeneInfoStr/{gene_ID}/anatomy/{anatomy_name}/disease/{disease_name}/phenotype/{phenotype_name}/viewType/{vtf}:
167+
get:
168+
description: Fetch all the studies in the Metabolomics Workbench for a given species, gene or list of genes, anatomy or tissue type, disease and phenotype.
169+
parameters:
170+
- in: path
171+
name: species_id
172+
description: The unique species name or identifier like hsa, Human, mmu, Mouse.
173+
schema:
174+
type: string
175+
example: hsa
176+
required: true
177+
- in: path
178+
name: geneID_type
179+
description: The unique Gene ID type like ENTREZID, SYMBOL, SYMBOL_OR_ALIAS, UNIPROT, ENSEMBL or REFSEQ
180+
schema:
181+
type: string
182+
example: SYMBOL
183+
required: true
184+
- in: path
185+
name: gene_ID
186+
description: The unigue gene identifier (e.g. 3098) in any one of the known formats (e.g. ENTREZID ) or double tab separated list of identifiers (3098__6120)
187+
schema:
188+
type: string
189+
example: HK1
190+
required: true
191+
- in: path
192+
name: anatomy_name
193+
description: The anatomy or tissue name (e.g. Blood, Lung, Liver)
194+
schema:
195+
type: string
196+
example: Blood or NA (for unspecified)
197+
required: true
198+
- in: path
199+
name: disease_name
200+
description: The disease name (e.g. Diabetes, Fatty liver disease)
201+
schema:
202+
type: string
203+
example: Diabetes or NA (for unspecified)
204+
required: true
205+
- in: path
206+
name: phenotype_name
207+
description: The phenotype name (e.g. BMI)
208+
schema:
209+
type: string
210+
example: BMI or NA (for unspecified)
211+
required: true
212+
- in: path
213+
name: vtf
214+
description: Media type e.g. json or txt
215+
schema:
216+
type: string
217+
example: json or txt
218+
required: true
219+
responses:
220+
'200':
221+
description: Success
222+
content:
223+
application/json:
224+
schema:
225+
type: object
226+
properties:
227+
KEGG_COMPOUND_ID:
228+
type: string
229+
description: KEGG Compound IDs
230+
REFMET_NAME:
231+
type: string
232+
description: Metabolomics Workbench unique Refmet name
233+
STUDY_ID:
234+
type: string
235+
description: A unique identifier for the study
236+
text/plain:
237+
schema:
238+
type: string
239+
example: pong
240+
x-responseValueType:
241+
- x-path: KEGG_COMPOUND_ID
242+
x-valueType: https://www.genome.jp/kegg/compound/
243+
- x-path: REFMET_NAME
244+
x-valueType: https://www.metabolomicsworkbench.org/databases/refmet/index.php

0 commit comments

Comments
 (0)