forked from VEuPathDB/service-dataset-access
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.raml
455 lines (400 loc) · 11.6 KB
/
api.raml
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
#%RAML 1.0 Extension
extends: https://raw.githubusercontent.com/VEuPathDB/docs-api-schema/v1.1.1/libraries/base-service.raml
title: Dataset Access Service
version: v1.0.0
mediaType: application/json
uses:
error: https://raw.githubusercontent.com/VEuPathDB/docs-api-schema/v1.1.1/libraries/errors.raml
lib: schema/library.raml
securitySchemes:
header-auth:
description: Authentication based on a WDK auth cookie.
type:
x-custom
describedBy:
headers:
Auth_Key:
description: Authorization header.
type: string
/staff:
get:
displayName: Staff List
description: List dataset staff in ascending order by ID.
queryParameters:
limit:
type: integer
minimum: 0
default: 100
description: Number of rows to include in the result
offset:
type: integer
minimum: 0
default: 0
description: Number of rows to skip from the result
responses:
200:
displayName: Success Response
body:
type: lib.StaffList
401:
displayName: Unauthorized
body: error.Unauthorized
403:
displayName: Forbidden
body: error.Forbidden
500:
displayName: Internal Server Error
body: error.Server
post:
displayName: New Staff Entry
description: Create a new dataset staff record.
body: lib.NewStaffRequest
responses:
200:
displayName: Success Response
body: lib.NewStaffResponse
400:
displayName: Bad Request
body: error.BadRequest
401:
displayName: Unauthorized
body: error.Unauthorized
403:
displayName: Forbidden
body: error.Forbidden
422:
displayName: Unprocessable Entity
body: error.UnprocessableEntity
500:
displayName: Internal Server Error
body: error.Server
/{staff-id}:
uriParameters:
staff-id:
type: lib.DatastoreId
patch:
displayName: Update Staff Entry
description: Update dataset staff.
body: lib.StaffPatch[]
responses:
204:
displayName: Success Response
400:
displayName: BadRequest
body: error.BadRequest
401:
displayName: Unauthorized
body: error.Unauthorized
403:
displayName: Forbidden
body: error.Forbidden
404:
displayName: Not Found
body: error.NotFound
422:
displayName: Unprocessable Entity
body: error.UnprocessableEntity
500:
displayName: Internal Server Error
body: error.Server
delete:
displayName: Delete Staff Entry
description: Delete dataset staff.
responses:
204:
displayName: Success Response
401:
displayName: Unauthorized
body: error.Unauthorized
403:
displayName: Forbidden
body: error.Forbidden
404:
displayName: Not Found
body: error.NotFound
500:
displayName: Internal Server Error
body: error.Server
/dataset-providers:
get:
displayName: Provider List
description: Get a list of providers for this dataset.
queryParameters:
datasetId:
type: string
required: true
limit:
type: integer
minimum: 0
default: 100
description: Number of rows to include in the result
offset:
type: integer
minimum: 0
default: 0
description: Number of rows to skip from the result
responses:
200:
displayName: Success Response
body: lib.DatasetProviderList
401:
displayName: Unauthorized
body: error.Unauthorized
403:
displayName: Forbidden
body: error.Forbidden
500:
displayName: Internal Server Error
body: error.Server
post:
displayName: New Provider
description: Create a new dataset provider record.
body: lib.DatasetProviderCreateRequest
responses:
200:
displayName: Success Response
body: lib.DatasetProviderCreateResponse
400:
displayName: Bad Request
body: error.BadRequest
401:
displayName: Unauthorized
body: error.Unauthorized
403:
displayName: Forbidden
body: error.Forbidden
422:
displayName: Unprocessable Entity
body: error.UnprocessableEntity
500:
displayName: Internal Server Error
body: error.Server
/{provider-id}:
uriParameters:
provider-id:
description: Dataset provider ID.
type: lib.DatastoreId
patch:
displayName: Update Provider
description: Update a dataset provider record.
body: lib.DatasetProviderPatch[]
responses:
204:
displayName: Success Response
400:
displayName: BadRequest
body: error.BadRequest
401:
displayName: Unauthorized
body: error.Unauthorized
403:
displayName: Forbidden
body: error.Forbidden
404:
displayName: Not Found
body: error.NotFound
422:
displayName: Unprocessable Entity
body: error.UnprocessableEntity
500:
displayName: Internal Server Error
body: error.Server
delete:
displayName: Delete Provider
description: Delete a dataset provider record.
responses:
204:
displayName: Success Response
401:
displayName: Unauthorized
body: error.Unauthorized
403:
displayName: Forbidden
body: error.Forbidden
404:
displayName: Not Found
body: error.NotFound
500:
displayName: Internal Server Error
body: error.Server
/dataset-end-users:
get:
displayName: List End Users
description: Get a list of all end-users for the specified dataset.
queryParameters:
datasetId:
displayName: Dataset ID
type: string
limit:
displayName: Result Limit
description: Number of rows to include in the result
type: integer
minimum: 0
default: 100
offset:
displayName: Result Offset
description: Number of rows to skip from the result
type: integer
minimum: 0
default: 0
approval:
displayName: Approval Status
description: Filter results by the approval status of the users.
type: lib.ApprovalStatus
responses:
200:
displayName: Success Response
body: lib.EndUserList
401:
displayName: Unauthorized
body: error.Unauthorized
403:
displayName: Forbidden
body: error.Forbidden
500:
displayName: Internal Server Error
body: error.Server
post:
displayName: New End User
description: Create a new dataset end-user record.
body: lib.EndUserCreateRequest
responses:
200:
displayName: Success Response
body: lib.EndUserCreateResponse
400:
displayName: Bad Request
body: error.BadRequest
401:
displayName: Unauthorized
body: error.Unauthorized
403:
displayName: Forbidden
body: error.Forbidden
422:
displayName: Unprocessable Entity
body: error.UnprocessableEntity
500:
displayName: Internal Server Error
body: error.Server
/{end-user-id}:
uriParameters:
end-user-id:
description: |
ID of a specific end-user record. This ID consists of the WDK user ID
for the user followed by a single dash (`-`) character followed by
the dataset ID. Example: `82-DS_897fe55e6f`.
type: string
pattern: "^\\d+-\\w+$"
get:
displayName: End User Details
description: Get the details of an end-user record.
responses:
200:
displayName: Success Response
body: lib.EndUser
401:
displayName: Unauthorized
body: error.Unauthorized
403:
displayName: Forbidden
body: error.Forbidden
404:
displayName: Not Found
body: error.NotFound
500:
displayName: Internal Server Error
body: error.Server
patch:
displayName: Update End User
description: |
Update an end user record.
The following rules apply to end user self updates:
1. The user may only submit updates while their access request is in the
"requested" status.
2. Only the following fields may be updated:
1. `purpose`
2. `researchQuestion`
3. `analysisPlan`
4. `disseminationPlan`
This endpoint supports only the listed JSON Patch operations on the
listed paths. All other JSON paths or operations will result in a 403
error.
**`/startDate`**
* `add`
* `remove`
* `replace`
This field may only be altered by site owners and dataset managers.
**`/duration`**
* `add`
* `remove`
* `replace`
This field may only be altered by site owners and dataset managers.
**`/restrictionLevel`**
* `replace`
This field may only be altered by site owners and dataset managers.
**`/purpose`**
* `replace`
Type: `string`
This field may be altered by site owners and dataset managers at any
time.
This field may only be altered by end users while their access request
is in the "requested" status.
**`/researchQuestion`**
* `replace`
Type: `string`
This field may be altered by site owners and dataset managers at any
time.
This field may only be altered by end users while their access request
is in the "requested" status.
**`/analysisPlan`**
* `replace`
Type: `string`
This field may be altered by site owners and dataset managers at any
time.
This field may only be altered by end users while their access request
is in the "requested" status.
**`/disseminationPlan`**
* `replace`
Type: `string`
This field may be altered by site owners and dataset managers at any
time.
This field may only be altered by end users while their access request
is in the "requested" status.
**`priorAuth`**
* `replace`
Type: `string`
This field may be altered by site owners and dataset managers at any
time.
This field may only be altered by end users while their access request
is in the "requested" status.
**`/approvalStatus`**
* `replace`
This field may only be altered by site owners and dataset managers.
**`/denialReason`**
* `add`
* `remove`
* `replace`
This field may only be altered by site owners and dataset managers.
body: lib.EndUserPatch[]
responses:
204:
displayName: Success Response
400:
displayName: BadRequest
body: error.BadRequest
401:
displayName: Unauthorized
body: error.Unauthorized
403:
displayName: Forbidden
body: error.Forbidden
404:
displayName: Not Found
body: error.NotFound
422:
displayName: Unprocessable Entity
body: error.UnprocessableEntity
500:
displayName: Internal Server Error
body: error.Server