chore: idisk api, add examples, remove rev-name field mapping

NCATS-Tangerine · Aug 23, 2021 · bede883 · bede883
1 parent abd81de
commit bede883
Showing 1 changed file with 20 additions and 5 deletions.
diff --git a/idisk/smartapi.yaml b/idisk/smartapi.yaml
@@ -395,6 +395,8 @@ components:
       requestBody:
         body:
           q: '{inputs[0]}'
+          ## example: put C0000392 (beta-Alanine)
+          ##   should get 10017947 (gastrointestinal disorders) back
           scopes: umls
         header: application/x-www-form-urlencoded
       inputs:
@@ -414,11 +416,13 @@ components:
     - supportBatch: true
       inputSeparator: ","
       parameters:
-        fields: name,umls
+        fields: umls
         size: 1000
       requestBody:
         body:
           q: '{inputs[0]}'
+          ## example: put 10017947 (gastrointestinal disorders) 
+          ##   should get C0000392 (beta-Alanine) back
           scopes: has_adverse_effect_on.meddra
         header: application/x-www-form-urlencoded
       inputs:
@@ -442,6 +446,8 @@ components:
       requestBody:
         body:
           q: '{inputs[0]}'
+          ## example: put C0000578 (5-Hydroxytryptophan) 
+          ##   should get C0027497 (nausea) back
           scopes: umls
         header: application/x-www-form-urlencoded
       inputs:
@@ -462,11 +468,13 @@ components:
     - supportBatch: true
       inputSeparator: ","
       parameters:
-        fields: name,umls
+        fields: umls
         size: 1000
       requestBody:
         body:
           q: '{inputs[0]}'
+          ## example: put C0027497 (nausea) 
+          ##   should get C0000578 (5-Hydroxytryptophan) back
           scopes: has_adverse_reaction.umls
         header: application/x-www-form-urlencoded
       inputs:
@@ -491,6 +499,8 @@ components:
       requestBody:
         body:
           q: '{inputs[0]}'
+          ## example: put C0000473 (4-Aminobenzoic Acid) 
+          ##   should get C0010137 (Cortisone) back
           scopes: umls
         header: application/x-www-form-urlencoded
       inputs:
@@ -507,11 +517,13 @@ components:
     - supportBatch: true
       inputSeparator: ","
       parameters:
-        fields: name,umls
+        fields: umls
         size: 1000
       requestBody:
         body:
           q: '{inputs[0]}'
+          ## example: put C0010137 (Cortisone) 
+          ##   should get C0000473 (4-Aminobenzoic Acid) back
           scopes: interacts_with.umls
         header: application/x-www-form-urlencoded
       inputs:
@@ -536,6 +548,8 @@ components:
       requestBody:
         body:
           q: '{inputs[0]}'
+          ## example: put C0000503 (gamma hydroxybutyrate) 
+          ##   should get C0016053 (Fibromyalgias) back
           scopes: umls
         header: application/x-www-form-urlencoded
       inputs:
@@ -553,11 +567,13 @@ components:
     - supportBatch: true
       inputSeparator: ","
       parameters:
-        fields: name,umls
+        fields: umls
         size: 1000
       requestBody:
         body:
           q: '{inputs[0]}'
+          ## example: put C0016053 (Fibromyalgias) 
+          ##   should get C0000503 (gamma hydroxybutyrate) back
           scopes: is_effective_for.umls
         header: application/x-www-form-urlencoded
       inputs:
@@ -577,7 +593,6 @@ components:
       source: has_adverse_effect_on.source.name
     rev:
       UMLS: umls
-      name: name
     has_adverse_reaction:
       UMLS: has_adverse_reaction.umls
       name: has_adverse_reaction.name