BiomarkerTranslatorAPI/biomarker_oas.yaml at master · SpectrumHealthResearch/BiomarkerTranslatorAPI · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
openapi: 3.0.2
info:
  title: Biomarker Translator API
  description: API to return biomarker information for the NCATS Biomedical Translator project.
  version: '1.0'

paths:
  /biomarker/{name}:
    get:
      parameters:
        - in: path
          name: name
          required: true
          schema:
            type: string
      description: List biomarker information, including related drugs and diseases
      responses:
        200:
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeList'
        400:
          description: Bad request
        404:
          description: Biomarker not found

  /drug/{name}:
    get:
      parameters:
        - in: path
          name: name
          required: true
          schema:
            type: string
      description: List drug names, targets, and associated biomarkers
      responses:
        200:
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeList'
        400:
          description: Bad request
        404:
          description: Drug not found


  /disease/{name}:
    get:
      parameters:
        - in: path
          name: name
          required: true
          schema:
            type: string
      description: List all related drugs and biomarkers
      responses:
        200:
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeList'
        400:
          description: Bad request
        404:
          description: Disease not found

  /patient/{patient_id}:
    get:
      parameters:
        - in: path
          name: patient_id
          required: true
          schema:
            type: string
      description: Show all records associated with OCTAD patient
      responses:
        200:
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeList'
        400:
          description: Bad request
        404:
          description: Patient not found

components:
  schemas:
    NodeList:
      type: object
      description: A list of nodes that answer the query
      properties:
        nodes:
          type: array
          description: List of matching nodes
          items:
            $ref: '#/components/schemas/Node'
    Node:
      type: object
      description: A node in a thought subgraph
      properties:
        id:
          type: string
        name:
          type: string
        type:
          oneOf:
            - type: string
            - type: array