-
Notifications
You must be signed in to change notification settings - Fork 20
/
endpoints.yaml
246 lines (246 loc) · 9.14 KB
/
endpoints.yaml
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
openapi: 3.0.2
servers: []
info:
version: 2.0.0
title: GA4GH Beacon API Specification - Biosamples endpoints
description: TBD
contact:
email: beacon@ga4gh.org
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
paths:
/biosamples:
get:
parameters:
- $ref: '#/components/parameters/requestedSchema'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/includeResultsetResponses'
- $ref: '#/components/parameters/filters'
description: Get a list of biosamples
operationId: getBiosamples
tags:
- GET Endpoints
responses:
'200':
$ref: '#/components/responses/ResultsOKResponse'
default:
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json
post:
description: Get a list of biosamples
operationId: postBiosamplesRequest
tags:
- POST Endpoints
requestBody:
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/requests/beaconRequestBody.json
required: true
responses:
'200':
$ref: '#/components/responses/ResultsOKResponse'
default:
description: An unsuccessful operation
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json
/biosamples/{id}:
parameters:
- $ref: '#/components/parameters/entryId'
get:
description: Get details about one biosample, identified by its (unique) 'id'
operationId: getOneBiosample
tags:
- GET Endpoints
responses:
'200':
$ref: '#/components/responses/ResultsOKResponse'
default:
description: An unsuccessful operation
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json
post:
description: Get details about one Biosample, identified by its (unique) 'id'
operationId: postOneBiosample
tags:
- POST Endpoints
requestBody:
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/requests/beaconRequestBody.json
required: true
responses:
'200':
$ref: '#/components/responses/ResultsOKResponse'
default:
description: An unsuccessful operation
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json
/biosamples/{id}/g_variants:
parameters:
- $ref: '#/components/parameters/entryId'
get:
parameters:
- $ref: '#/components/parameters/requestedSchema'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/limit'
description: Get the genomic variants list from one biosample, identified by
its (unique) 'id'
operationId: getOneBiosampleGenomicVariants
tags:
- GET Endpoints
responses:
'200':
$ref: '#/components/responses/ResultsOKResponse'
default:
description: An unsuccessful operation
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json
post:
description: Get the genomic variants list from one biosample, identified by
its (unique) 'id'
operationId: postOneBiosampleGenomicVariants
tags:
- POST Endpoints
requestBody:
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/requests/beaconRequestBody.json
required: true
responses:
'200':
$ref: '#/components/responses/ResultsOKResponse'
default:
description: An unsuccessful operation
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json
/biosamples/{id}/analyses:
parameters:
- $ref: '#/components/parameters/entryId'
get:
parameters:
- $ref: '#/components/parameters/requestedSchema'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/limit'
description: Get the analysis list from one biosample, identified by its (unique)
'id'
operationId: getOneBiosampleAnalysis
tags:
- GET Endpoints
responses:
'200':
$ref: '#/components/responses/ResultsOKResponse'
default:
description: An unsuccessful operation
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json
post:
description: Get the analysis list from one biosample, identified by its (unique)
'id'
operationId: postOneBiosampleAnalysis
tags:
- POST Endpoints
requestBody:
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/requests/beaconRequestBody.json
required: true
responses:
'200':
$ref: '#/components/responses/ResultsOKResponse'
default:
description: An unsuccessful operation
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json
/biosamples/{id}/runs:
parameters:
- $ref: '#/components/parameters/entryId'
get:
parameters:
- $ref: '#/components/parameters/requestedSchema'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/limit'
description: Get the runs list from one biosample, identified by its (unique)
'id'
operationId: getOneBiosampleRuns
tags:
- GET Endpoints
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconResultsetsResponse.json
default:
description: An unsuccessful operation
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json
post:
description: Get the runs list from one biosample, identified by its (unique)
'id'
operationId: postOneBiosampleRuns
tags:
- POST Endpoints
requestBody:
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/requests/beaconRequestBody.json
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconResultsetsResponse.json
default:
description: An unsuccessful operation
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json
components:
responses:
ResultsOKResponse:
description: Successful operation.
content:
application/json:
schema:
oneOf:
- $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconBooleanResponse.json
- $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCountResponse.json
- $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconResultsetsResponse.json
parameters:
requestedSchema:
name: requestedSchema
description: Schema to be used to format the `result` field in the response.
The response will use Beacon format.
in: query
required: false
schema:
type: string
example: ga4gh-service-info-v1.0
skip:
name: skip
in: query
schema:
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/beaconCommonComponents.json#/definitions/Skip
limit:
name: limit
in: query
schema:
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/beaconCommonComponents.json#/definitions/Limit
includeResultsetResponses:
$ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/common/beaconCommonComponents.json#/definitions/IncludeResultsetResponses
entryId:
name: id
in: path
required: true
schema:
type: string
filters:
name: filters
in: query
schema:
type: array
items:
type: string
examples:
- - NCIT:C3222
- - OBI:0100058
- NCIT:C4813