Skip to content

Commit c908846

Browse files
committed
Fixed openapi.yml.
1 parent 424a1f5 commit c908846

File tree

1 file changed

+79
-78
lines changed

1 file changed

+79
-78
lines changed

node_normalizer/resources/openapi.yml

Lines changed: 79 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ paths:
5050
<a href="https://github.com/NCATSTranslator/NodeNormalization/blob/master/documentation/API.md#status">NodeNorm API documentation</a>.'
5151
responses:
5252
'200':
53+
description: Successful result describing this NodeNorm instance.
5354
content:
5455
application/json:
5556
schema:
@@ -68,15 +69,15 @@ paths:
6869
description: 'Returns the curies and their hit count for a semantic type(s). You can read more about this endpoint
6970
in the <a href="https://github.com/NCATSTranslator/NodeNormalization/blob/master/documentation/API.md#get_curie_prefixes">NodeNorm API documentation</a>.'
7071
parameters:
71-
- in: query
72-
name: semantic_type
73-
schema:
74-
example:
75-
- biolink:ChemicalEntity
76-
- biolink:AnatomicalEntity
77-
items:
78-
type: string
79-
type: array
72+
- in: query
73+
name: semantic_type
74+
schema:
75+
example:
76+
- biolink:ChemicalEntity
77+
- biolink:AnatomicalEntity
78+
items:
79+
type: string
80+
type: array
8081
responses:
8182
'200':
8283
content:
@@ -101,40 +102,40 @@ paths:
101102
"KEGG.COMPOUND": "16039"
102103
"biolink:AnatomicalEntity":
103104
curie_prefix:
104-
"UMLS": "159941",
105-
"FMA": "98631",
106-
"UBERON": "14564",
107-
"ZFA": "606",
108-
"NCIT": "10286",
109-
"MESH": "1992",
110-
"EMAPA": "966",
111-
"FBbt": "117",
112-
"WBbt": "18",
113-
"GO": "4041",
114-
"SNOMEDCT": "1422",
105+
"UMLS": "159941"
106+
"FMA": "98631"
107+
"UBERON": "14564"
108+
"ZFA": "606"
109+
"NCIT": "10286"
110+
"MESH": "1992"
111+
"EMAPA": "966"
112+
"FBbt": "117"
113+
"WBbt": "18"
114+
"GO": "4041"
115+
"SNOMEDCT": "1422"
115116
"CL": "3043"
116117
type: object
117118
description: Results
118119
summary: Return the number of times each CURIE prefix appears in an equivalent
119120
identifier for a semantic type
120121
tags:
121-
- Interfaces
122+
- Interfaces
122123
/get_normalized_nodes:
123124
get:
124125
description: 'Returns the equivalent identifiers and semantic types for the CURIEs entered.
125126
You can optionally <a href="https://github.com/NCATSTranslator/Babel/blob/master/docs/Conflation.md">conflate identifiers</a> if needed.
126127
You can read more about this endpoint in the
127128
<a href="https://github.com/NCATSTranslator/NodeNormalization/blob/master/documentation/API.md#get_normalized_nodes">NodeNorm API documentation</a>.'
128129
parameters:
129-
- in: query
130-
name: curie
131-
schema:
132-
example:
133-
- MESH:D014867
134-
- NCIT:C34373
135-
items:
136-
type: string
137-
type: array
130+
- in: query
131+
name: curie
132+
schema:
133+
example:
134+
- MESH:D014867
135+
- NCIT:C34373
136+
items:
137+
type: string
138+
type: array
138139
responses:
139140
'200':
140141
content:
@@ -146,56 +147,56 @@ paths:
146147
identifier: CHEBI:15377
147148
label: Water
148149
equivalent_identifiers:
149-
- identifier: CHEBI:15377
150-
label: Water
151-
- identifier: CHEMBL.COMPOUND:CHEMBL1098659
152-
label: WATER
153-
- identifier: DRUGBANK:DB09145
154-
- identifier: PUBCHEM:22247451
155-
- identifier: PUBCHEM:962
156-
- identifier: MESH:D014867
157-
- identifier: HMDB:HMDB0002111
158-
- identifier: INCHIKEY:XLYOFNOQVPJJNP-UHFFFAOYSA-N
159-
- identifier: UNII:059QF0K00R
160-
- identifier: KEGG.COMPOUND:C00001
150+
- identifier: CHEBI:15377
151+
label: Water
152+
- identifier: CHEMBL.COMPOUND:CHEMBL1098659
153+
label: WATER
154+
- identifier: DRUGBANK:DB09145
155+
- identifier: PUBCHEM:22247451
156+
- identifier: PUBCHEM:962
157+
- identifier: MESH:D014867
158+
- identifier: HMDB:HMDB0002111
159+
- identifier: INCHIKEY:XLYOFNOQVPJJNP-UHFFFAOYSA-N
160+
- identifier: UNII:059QF0K00R
161+
- identifier: KEGG.COMPOUND:C00001
161162
type:
162-
- biolink:SmallMolecule
163-
- biolink:MolecularEntity
164-
- biolink:ChemicalEntity
165-
- biolink:PhysicalEssence
166-
- biolink:ChemicalOrDrugOrTreatment
167-
- biolink:ChemicalEntityOrGeneOrGeneProduct
168-
- biolink:ChemicalEntityOrProteinOrPolypeptide
169-
- biolink:NamedThing
170-
- biolink:PhysicalEssenceOrOccurrent
163+
- biolink:SmallMolecule
164+
- biolink:MolecularEntity
165+
- biolink:ChemicalEntity
166+
- biolink:PhysicalEssence
167+
- biolink:ChemicalOrDrugOrTreatment
168+
- biolink:ChemicalEntityOrGeneOrGeneProduct
169+
- biolink:ChemicalEntityOrProteinOrPolypeptide
170+
- biolink:NamedThing
171+
- biolink:PhysicalEssenceOrOccurrent
171172
information_content: 47.5
172173
NCIT:C34373:
173174
equivalent_identifiers:
174-
- identifier: MONDO:0004976
175-
label: amyotrophic lateral sclerosis
176-
- identifier: DOID:332
177-
- identifier: OPPHANET:803
178-
- identifier: UMLS:C0393554
179-
- identifier: MESH:D000690
180-
- identifier: MEDDRA:10002026
181-
- identifier: NCIT:C34373
182-
- identifier: HP:0007354
183-
label: Amyotrophic lateral sclerosis
175+
- identifier: MONDO:0004976
176+
label: amyotrophic lateral sclerosis
177+
- identifier: DOID:332
178+
- identifier: OPPHANET:803
179+
- identifier: UMLS:C0393554
180+
- identifier: MESH:D000690
181+
- identifier: MEDDRA:10002026
182+
- identifier: NCIT:C34373
183+
- identifier: HP:0007354
184+
label: Amyotrophic lateral sclerosis
184185
id:
185186
identifier: MONDO:0004976
186187
label: amyotrophic lateral sclerosis
187188
type:
188-
- biolink:Disease
189-
- biolink:DiseaseorPhenotypicFeature
190-
- biolink:BiologicalEntity
191-
- biolink:ThingWithTaxon
192-
- biolink:NamedThing
189+
- biolink:Disease
190+
- biolink:DiseaseorPhenotypicFeature
191+
- biolink:BiologicalEntity
192+
- biolink:ThingWithTaxon
193+
- biolink:NamedThing
193194
information_content: 74.9
194195
type: object
195196
description: Results
196197
summary: Get the equivalent identifiers and semantic types for the CURIEs entered.
197198
tags:
198-
- Interfaces
199+
- Interfaces
199200
/get_semantic_types:
200201
get:
201202
description: 'Returns a distinct set of the semantic types discovered in the
@@ -221,19 +222,19 @@ paths:
221222
summary: Return a list of BioLink semantic types for which normalization has
222223
been attempted.
223224
tags:
224-
- Interfaces
225+
- Interfaces
225226
/get_allowed_conflations:
226227
get:
227228
description: 'Returns a list of allowed conflation options. Conflation allows cliques to be combined on-the-fly
228-
on the basis of two different criteria:
229-
<ol>
230-
<li><code>GeneProtein</code> conflation merges protein-coding genes with the proteins they encode. The gene(s) always
231-
appear first in the combined clique.
232-
<li><code>DrugChemical</code> conflation merges chemicals based on their active ingredient. We attempt to ensure that
233-
the active ingredient appears before any formulations in the combined clique.
234-
</ol>
235-
You can read <a href="https://github.com/NCATSTranslator/Babel/blob/master/docs/Conflation.md">more about conflation</a> or
236-
<a href="https://github.com/NCATSTranslator/NodeNormalization/blob/master/documentation/API.md#get_allowed_conflations">more about this endpoint</a>.'
229+
on the basis of two different criteria:
230+
<ol>
231+
<li><code>GeneProtein</code> conflation merges protein-coding genes with the proteins they encode. The gene(s) always
232+
appear first in the combined clique.
233+
<li><code>DrugChemical</code> conflation merges chemicals based on their active ingredient. We attempt to ensure that
234+
the active ingredient appears before any formulations in the combined clique.
235+
</ol>
236+
You can read <a href="https://github.com/NCATSTranslator/Babel/blob/master/docs/Conflation.md">more about conflation</a> or
237+
<a href="https://github.com/NCATSTranslator/NodeNormalization/blob/master/documentation/API.md#get_allowed_conflations">more about this endpoint</a>.'
237238
responses:
238239
'200':
239240
content:
@@ -247,7 +248,7 @@ paths:
247248
description: Results
248249
summary: Return a list of named conflations.
249250
tags:
250-
- Interfaces
251+
- Interfaces
251252
/get_setid:
252253
get:
253254
description: 'Returns the set ID for a given set of CURIEs. A set ID is an identifier that can be used to identify

0 commit comments

Comments
 (0)