This repository was archived by the owner on Feb 22, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathopenapi-schema.yml
More file actions
610 lines (610 loc) · 15.4 KB
/
openapi-schema.yml
File metadata and controls
610 lines (610 loc) · 15.4 KB
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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
openapi: 3.0.2
info:
title: ''
version: ''
paths:
/runHistos/API/:
get:
operationId: listRunHistos
description: ''
parameters:
- name: run__run_number__gte
required: false
in: query
description: run__run_number__gte
schema:
type: string
- name: run__run_number__lte
required: false
in: query
description: run__run_number__lte
schema:
type: string
- name: entries__gte
required: false
in: query
description: entries__gte
schema:
type: string
- name: entries__lte
required: false
in: query
description: entries__lte
schema:
type: string
- name: mean__gte
required: false
in: query
description: mean__gte
schema:
type: string
- name: mean__lte
required: false
in: query
description: mean__lte
schema:
type: string
- name: rms__gte
required: false
in: query
description: rms__gte
schema:
type: string
- name: rms__lte
required: false
in: query
description: rms__lte
schema:
type: string
- name: skewness__gte
required: false
in: query
description: skewness__gte
schema:
type: string
- name: skewness__lte
required: false
in: query
description: skewness__lte
schema:
type: string
- name: kurtosis__gte
required: false
in: query
description: kurtosis__gte
schema:
type: string
- name: kurtosis__lte
required: false
in: query
description: kurtosis__lte
schema:
type: string
- name: title
required: false
in: query
description: title
schema:
type: string
- name: primary_dataset
required: false
in: query
description: primary_dataset
schema:
type: string
- name: run__run_number__in
required: false
in: query
description: run__run_number__in
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RunHistos'
description: ''
tags:
- runHistos
/lumisectionHistos1D/API/:
get:
operationId: listLumisectionHisto1Ds
description: ''
parameters:
- name: lumisection__run__run_number__gte
required: false
in: query
description: lumisection__run__run_number__gte
schema:
type: string
- name: lumisection__run__run_number__lte
required: false
in: query
description: lumisection__run__run_number__lte
schema:
type: string
- name: lumisection__ls_number__gte
required: false
in: query
description: lumisection__ls_number__gte
schema:
type: string
- name: lumisection__ls_number__lte
required: false
in: query
description: lumisection__ls_number__lte
schema:
type: string
- name: entries__gte
required: false
in: query
description: entries__gte
schema:
type: string
- name: entries__lte
required: false
in: query
description: entries__lte
schema:
type: string
- name: title
required: false
in: query
description: title
schema:
type: string
- name: lumisection__ls_number__in
required: false
in: query
description: lumisection__ls_number__in
schema:
type: string
- name: lumisection__run__run_number__in
required: false
in: query
description: lumisection__run__run_number__in
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LumisectionHisto1D'
description: ''
tags:
- lumisectionHistos1D
/lumisectionHistos2D/API/:
get:
operationId: listLumisectionHisto2Ds
description: ''
parameters:
- name: lumisection__run__run_number__gte
required: false
in: query
description: lumisection__run__run_number__gte
schema:
type: string
- name: lumisection__run__run_number__lte
required: false
in: query
description: lumisection__run__run_number__lte
schema:
type: string
- name: lumisection__ls_number__gte
required: false
in: query
description: lumisection__ls_number__gte
schema:
type: string
- name: lumisection__ls_number__lte
required: false
in: query
description: lumisection__ls_number__lte
schema:
type: string
- name: entries__gte
required: false
in: query
description: entries__gte
schema:
type: string
- name: entries__lte
required: false
in: query
description: entries__lte
schema:
type: string
- name: title
required: false
in: query
description: title
schema:
type: string
- name: lumisection__ls_number__in
required: false
in: query
description: lumisection__ls_number__in
schema:
type: string
- name: lumisection__run__run_number__in
required: false
in: query
description: lumisection__run__run_number__in
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LumisectionHisto2D'
description: ''
tags:
- lumisectionHistos2D
/api/histogram_data_files/:
get:
operationId: listHistogramDataFiles
description: ''
parameters: []
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/HistogramDataFile'
description: ''
tags:
- api
post:
operationId: createHistogramDataFile
description: ''
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HistogramDataFile'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/HistogramDataFile'
multipart/form-data:
schema:
$ref: '#/components/schemas/HistogramDataFile'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/HistogramDataFile'
description: ''
tags:
- api
/api/histogram_data_files/{id}/:
get:
operationId: retrieveHistogramDataFile
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this histogram data file.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HistogramDataFile'
description: ''
tags:
- api
put:
operationId: updateHistogramDataFile
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this histogram data file.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HistogramDataFile'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/HistogramDataFile'
multipart/form-data:
schema:
$ref: '#/components/schemas/HistogramDataFile'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HistogramDataFile'
description: ''
tags:
- api
patch:
operationId: partialUpdateHistogramDataFile
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this histogram data file.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HistogramDataFile'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/HistogramDataFile'
multipart/form-data:
schema:
$ref: '#/components/schemas/HistogramDataFile'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HistogramDataFile'
description: ''
tags:
- api
delete:
operationId: destroyHistogramDataFile
description: ''
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this histogram data file.
schema:
type: string
responses:
'204':
description: ''
tags:
- api
/api/histogram_data_files/{id}/start_parsing/:
post:
operationId: startParsingHistogramDataFile
description: Start parsing a specific HistogramDataFile, identified by pk
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this histogram data file.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HistogramDataFile'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/HistogramDataFile'
multipart/form-data:
schema:
$ref: '#/components/schemas/HistogramDataFile'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/HistogramDataFile'
description: ''
tags:
- api
components:
schemas:
RunHistos:
type: object
properties:
id:
type: integer
readOnly: true
run:
type: integer
readOnly: true
primary_dataset:
type: string
maxLength: 220
title:
type: string
maxLength: 220
entries:
type: integer
maximum: 9223372036854775807
minimum: -9223372036854775808
format: int64
nullable: true
mean:
type: number
nullable: true
rms:
type: number
nullable: true
skewness:
type: number
nullable: true
kurtosis:
type: number
nullable: true
required:
- primary_dataset
- title
LumisectionHisto1D:
type: object
properties:
id:
type: integer
readOnly: true
run:
type: integer
readOnly: true
lumisection:
type: integer
readOnly: true
title:
type: string
maxLength: 100
data:
type: array
items:
type: number
entries:
type: integer
maximum: 2147483647
minimum: -2147483648
nullable: true
x_min:
type: number
nullable: true
x_max:
type: number
nullable: true
x_bin:
type: integer
maximum: 2147483647
minimum: -2147483648
nullable: true
source_data_file:
type: integer
nullable: true
description: Source data file that the specific Histogram was read from,
if any
required:
- title
LumisectionHisto2D:
type: object
properties:
id:
type: integer
readOnly: true
run:
type: integer
readOnly: true
lumisection:
type: integer
readOnly: true
title:
type: string
maxLength: 100
data:
type: array
items:
type: number
entries:
type: integer
maximum: 2147483647
minimum: -2147483648
nullable: true
x_min:
type: number
nullable: true
x_max:
type: number
nullable: true
x_bin:
type: integer
maximum: 2147483647
minimum: -2147483648
nullable: true
y_max:
type: number
nullable: true
y_min:
type: number
nullable: true
y_bin:
type: integer
maximum: 2147483647
minimum: -2147483648
nullable: true
source_data_file:
type: integer
nullable: true
description: Source data file that the specific Histogram was read from,
if any
required:
- title
HistogramDataFile:
type: object
properties:
id:
type: integer
readOnly: true
percentage_processsed:
type: number
filepath:
enum:
- ''
- /home/mpliax/Desktop/tmp/ZeroBias_2018A_DataFrame_1D_2.csv
- /home/mpliax/Desktop/tmp/ZeroBias_2018A_DataFrame_2D_2.csv
type: string
description: Path where the file is stored
filesize:
type: integer
maximum: 2147483647
description: The data file's size (bytes)
minimum: 0
data_dimensionality:
enum:
- 1
- 2
type: integer
minimum: 0
maximum: 2147483647
data_era:
type: string
description: The era that the data refers to (e.g. 2018A)
maxLength: 5
entries_total:
type: integer
maximum: 2147483647
description: Total number of entries contained in this histogram file
minimum: 0
entries_processed:
type: integer
maximum: 2147483647
description: Number of histogram entries that have been extracted from the
file
minimum: 0
granularity:
enum:
- run
- lum
type: string
description: The granularity of the data contained in the data file (either
whole run or lumisections)
created:
type: string
format: date-time
readOnly: true
modified:
type: string
format: date-time
readOnly: true
required:
- percentage_processsed
- filepath