spec sheet change

KarrLab · Aug 29, 2019 · 0f67028 · 0f67028
1 parent ce1f4ed
commit 0f67028
Showing 1 changed file with 94 additions and 0 deletions.
diff --git a/datanator_rest_api/spec/DatanatorAPI.yaml b/datanator_rest_api/spec/DatanatorAPI.yaml
@@ -89,6 +89,36 @@ paths:
       summary: Add a new metabolite
       tags:
       - Metabolites
+  /metabolites/concentration/:
+    get:
+      description: Some description
+      parameters:
+      - in: query
+        name: abstract
+        required: false
+        schema:
+          type: boolean
+      - in: query
+        name: species
+        required: false
+        schema:
+          type: string
+      - in: query
+        name: metabolite
+        required: true
+        schema:
+          type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MetaboliteConcentration'
+          description: OK
+      summary: Get metabolite concentration based on species and metabolite name
+      tags:
+      - Metabolites
+      - Concentration
   /metabolites/concentrations/:
     get:
       description: Get concentration data for metabolites. The inchikeys parameter
@@ -373,6 +403,70 @@ components:
       - inchi
       - name
       type: object
+    MetaboliteConcentration:
+      properties:
+        concentrations:
+          items:
+            properties:
+              error:
+                description: A numerical value corresponding to the error in the measurment,
+                  in the same units as the measurment
+                example: '1'
+                type: number
+              experimental_conditions:
+                items:
+                  type: string
+                type: array
+              measurment:
+                description: A numerical value corresponding to the observed value
+                  of the measurment
+                example: 3.8
+                type: number
+              measurment_type:
+                description: The type of measurment being made
+                enum:
+                - concentration
+                - abundance
+                - mass
+                type: string
+              source:
+                example: doi:10.1038/nphys1170
+                type: string
+              species:
+                example: Homo sapiens
+                type: string
+              units:
+                description: The units that the measurment was made in
+                example: uMolar
+                type: string
+            required:
+            - measurment_type
+            - measurment
+            - units
+            - species
+            - source
+            type: object
+          type: array
+        inchi:
+          type: string
+        inchi_key:
+          type: string
+        name:
+          type: string
+        reactions:
+          items:
+            properties:
+              id:
+                type: string
+            required:
+            - id
+            type: object
+          type: array
+      required:
+      - inchi_key
+      - inchi
+      - name
+      type: object
     Observation:
       properties:
         error: