-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi-source.yaml
1670 lines (1670 loc) · 47.2 KB
/
openapi-source.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
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
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: ALICE Bookkeeping
version: 0.0.0
license:
name: GNU General Public License v3.0
url: 'http://alice-o2.web.cern.ch/license'
servers:
- url: /api
paths:
/:
get:
operationId: getServerInformation
summary: Get server information
responses:
'200':
description: API information
content:
application/json:
schema:
$ref: '#/components/schemas/ApiInformation'
default:
$ref: '#/components/responses/UnexpectedError'
/attachments:
post:
operationId: createAttachment
summary: Create a new attachment on a log
requestBody:
$ref: '#/components/requestBodies/CreateAttachments'
responses:
'201':
$ref: '#/components/responses/ArrayOfAttachments'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- attachment
'/attachments/{attachmentId}':
parameters:
- $ref: '#/components/parameters/AttachmentId'
get:
operationId: getAttachment
summary: Get one specific attachment
responses:
'200':
$ref: '#/components/responses/ArrayOfAttachments'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- attachment
/flps:
get:
operationId: listFlps
summary: List all flps
# parameters:
# - $ref: '#/components/parameters/Pagination'
# - $ref: '#/components/parameters/FlpSorting'
responses:
'200':
$ref: '#/components/responses/ArrayOfFlps'
'400':
$ref: '#/components/responses/BadRequest'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- flp
post:
operationId: createFlp
summary: Adds a new flp
requestBody:
$ref: '#/components/requestBodies/CreateFlp'
responses:
'201':
$ref: '#/components/responses/Log'
'400':
$ref: '#/components/responses/BadRequest'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- flp
'/flps/{flpId}':
parameters:
- $ref: '#/components/parameters/FlpId'
get:
operationId: getFlpById
summary: Gets a flp by Id
responses:
'200':
$ref: '#/components/responses/Flp'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- flp
patch:
operationId: updateFlp
summary: Update an existing flp
requestBody:
$ref: '#/components/requestBodies/UpdateFlp'
responses:
'200':
$ref: '#/components/responses/Flp'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- flp
/logs:
get:
operationId: listLogs
summary: List all logs
# parameters:
# - $ref: '#/components/parameters/Pagination'
# - $ref: '#/components/parameters/FilterLogs'
# - $ref: '#/components/parameters/LogSorting'
responses:
'200':
$ref: '#/components/responses/ArrayOfLogs'
'400':
$ref: '#/components/responses/BadRequest'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- log
post:
operationId: createLog
summary: Adds a new log
requestBody:
$ref: '#/components/requestBodies/CreateLog'
responses:
'201':
$ref: '#/components/responses/Log'
'400':
$ref: '#/components/responses/BadRequest'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- log
'/logs/{logId}':
parameters:
- $ref: '#/components/parameters/LogId'
get:
operationId: getLogById
summary: Gets a log by Id
responses:
'200':
$ref: '#/components/responses/Log'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- log
'/logs/{logId}/attachments':
parameters:
- $ref: '#/components/parameters/LogId'
get:
operationId: listLogAttachments
summary: Get all attachments associated with a log
responses:
'200':
$ref: '#/components/responses/ArrayOfAttachments'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- log
'/logs/{logId}/attachments/{attachmentId}':
parameters:
- $ref: '#/components/parameters/LogId'
- $ref: '#/components/parameters/AttachmentId'
get:
operationId: getLogAttachment
summary: Get one specific attachment associated with a log
responses:
'200':
$ref: '#/components/responses/Attachment'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- log
'/logs/{logId}/tags':
parameters:
- $ref: '#/components/parameters/LogId'
get:
operationId: listTagsByLogId
summary: Lists all tags associated with a log
responses:
'200':
$ref: '#/components/responses/ArrayOfTags'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- log
'/logs/{logId}/tree':
parameters:
- $ref: '#/components/parameters/LogId'
get:
operationId: getLogTree
summary: Get the Log tree for a given Log
responses:
'200':
$ref: '#/components/responses/LogTree'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- log
/runs:
get:
operationId: listRuns
summary: List all runs
# parameters:
# - $ref: '#/components/parameters/Pagination'
# - $ref: '#/components/parameters/RunSorting'
responses:
'200':
$ref: '#/components/responses/ArrayOfRuns'
'400':
$ref: '#/components/responses/BadRequest'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- run
post:
operationId: createRun
summary: Creates a run
requestBody:
$ref: '#/components/requestBodies/CreateRun'
responses:
'201':
$ref: '#/components/responses/Run'
'400':
$ref: '#/components/responses/BadRequest'
'409':
$ref: '#/components/responses/Conflict'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- run
'/runs/{runId}':
parameters:
- $ref: '#/components/parameters/RunId'
get:
operationId: getRunById
summary: Gets a run by Id
responses:
'200':
$ref: '#/components/responses/Run'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- run
patch:
operationId: endRun
summary: Updates certain fields of a run
requestBody:
$ref: '#/components/requestBodies/EndRun'
responses:
'201':
$ref: '#/components/responses/Run'
'400':
$ref: '#/components/responses/BadRequest'
'409':
$ref: '#/components/responses/Conflict'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- run
/status:
get:
operationId: getDeployInformation
summary: Get deploy information
responses:
'200':
description: Deploy information
content:
application/json:
schema:
$ref: '#/components/schemas/DeployInformation'
default:
$ref: '#/components/responses/UnexpectedError'
/subsystems:
get:
operationId: listSubsystems
summary: List all subsystems
# parameters:
# - $ref: '#/components/parameters/Pagination'
responses:
'200':
$ref: '#/components/responses/ArrayOfSubsystems'
'400':
$ref: '#/components/responses/BadRequest'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- subsystem
post:
operationId: createSubsystem
summary: Adds a new subsystem
requestBody:
$ref: '#/components/requestBodies/CreateSubsystem'
responses:
'201':
$ref: '#/components/responses/Subsystem'
'400':
$ref: '#/components/responses/BadRequest'
'409':
$ref: '#/components/responses/Conflict'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- subsystem
'/subsystems/{subsystemId}':
parameters:
- $ref: '#/components/parameters/SubsystemId'
get:
operationId: getSubsystem
summary: Get a subsystem by Id
responses:
'200':
$ref: '#/components/responses/Subsystem'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- subsystem
delete:
operationId: deleteSubsystem
summary: Deletes a subsystem by Id
responses:
'200':
$ref: '#/components/responses/Subsystem'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- subsystem
/tags:
get:
operationId: listTags
summary: List all tags
# parameters:
# - $ref: '#/components/parameters/Pagination'
responses:
'200':
$ref: '#/components/responses/ArrayOfTags'
'400':
$ref: '#/components/responses/BadRequest'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- tag
post:
operationId: createTag
summary: Adds a new tag
requestBody:
$ref: '#/components/requestBodies/CreateTag'
responses:
'201':
$ref: '#/components/responses/Tag'
'400':
$ref: '#/components/responses/BadRequest'
'409':
$ref: '#/components/responses/Conflict'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- tag
'/tags/{tagId}':
parameters:
- $ref: '#/components/parameters/TagId'
get:
operationId: getTagById
summary: Gets a tag by Id
responses:
'200':
$ref: '#/components/responses/Tag'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- tag
delete:
operationId: deleteTagById
summary: Deletes a tag by Id
responses:
'200':
$ref: '#/components/responses/Tag'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- tag
'/tags/{tagId}/logs':
parameters:
- $ref: '#/components/parameters/TagId'
get:
operationId: getLogsByTagId
summary: Gets all logs with this tag id
responses:
'200':
$ref: '#/components/responses/ArrayOfLogs'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/UnexpectedError'
tags:
- tag
components:
parameters:
AttachmentId:
name: attachmentId
description: The id of the attached to retrieve
in: path
required: true
schema:
$ref: '#/components/schemas/EntityId'
FilterLogs:
name: filter
description: Specifies the filter requirements.
in: query
schema:
$ref: '#/components/schemas/FilterLogsOptions'
style: deepObject
FlpId:
name: flpId
description: The id of the flp to retrieve
in: path
required: true
schema:
$ref: '#/components/schemas/EntityId'
FlpSorting:
in: query
name: sort
description: Specifies the flp sorting requirements.
required: false
schema:
$ref: '#/components/schemas/FlpSortOptions'
style: deepObject
LogId:
name: logId
description: The id of the log to retrieve
in: path
required: true
schema:
$ref: '#/components/schemas/EntityId'
LogSorting:
in: query
name: sort
description: Specifies the log sorting requirements.
required: false
schema:
$ref: '#/components/schemas/LogSortOptions'
style: deepObject
Pagination:
name: page
description: Specifies the pagination requirements.
in: query
schema:
$ref: '#/components/schemas/PaginationOptions'
style: deepObject
RunId:
name: runId
description: The id of the run to retrieve
in: path
required: true
schema:
$ref: '#/components/schemas/EntityId'
RunSorting:
in: query
name: sort
description: Specifies the run sorting requirements.
required: false
schema:
$ref: '#/components/schemas/RunSortOptions'
style: deepObject
SubsystemId:
name: subsystemId
description: The id of the subsystem to retrieve
in: path
required: true
schema:
$ref: '#/components/schemas/EntityId'
TagId:
name: tagId
description: The id of the tag to retrieve
in: path
required: true
schema:
$ref: '#/components/schemas/EntityId'
requestBodies:
CreateRun:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Run'
EndRun:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Run'
CreateAttachments:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAttachments'
CreateFlp:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFlp'
CreateLog:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLog'
CreateSubsystem:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSubsystem'
CreateTag:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTag'
UpdateFlp:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFlp'
responses:
ArrayOfAttachments:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfAttachmentsResponse'
ArrayOfFlps:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfFlpsResponse'
ArrayOfLogs:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfLogsResponse'
ArrayOfRuns:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfRunsResponse'
ArrayOfSubsystems:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfSubsystemsResponse'
ArrayOfTags:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: '#/components/schemas/ArrayOfTagsResponse'
Attachment:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: '#/components/schemas/AttachmentResponse'
BadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
Conflict:
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
Flp:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: '#/components/schemas/FlpResponse'
Log:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: '#/components/schemas/LogResponse'
LogTree:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: '#/components/schemas/LogTreeResponse'
NotFound:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
Run:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: '#/components/schemas/RunResponse'
ServiceUnavailable:
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
Subsystem:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: '#/components/schemas/SubsystemResponse'
Tag:
description: Expected response to a valid request.
content:
application/json:
schema:
$ref: '#/components/schemas/TagResponse'
UnexpectedError:
description: Unexpected Error
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
securitySchemes:
ApiKeyAuth:
type: apiKey
in: query
name: token
schemas:
ApiInformation:
description: API information
type: object
properties:
name:
description: Name of the API
type: string
version:
description: Version of the API
type: string
required:
- name
- version
additionalProperties: false
ArrayOfAttachments:
description: A list of attachment objects.
type: array
items:
$ref: '#/components/schemas/Attachment'
ArrayOfAttachmentsResponse:
description: Response containing multiple attachments.
type: object
properties:
data:
$ref: '#/components/schemas/ArrayOfAttachments'
required:
- data
additionalProperties: false
ArrayOfFlps:
description: A list of Flp objects.
type: array
items:
$ref: '#/components/schemas/Flp'
ArrayOfFlpsResponse:
description: Response containing multiple flps.
type: object
properties:
data:
$ref: '#/components/schemas/ArrayOfFlps'
meta:
$ref: '#/components/schemas/ArrayOfFlpsResponseMeta'
required:
- data
additionalProperties: false
ArrayOfFlpsResponseMeta:
description: The metadata related to an array of flps response.
type: object
properties:
page:
$ref: '#/components/schemas/PaginationMeta'
required:
- page
additionalProperties: false
ArrayOfLogTrees:
description: A list of Log tree objects.
type: array
items:
$ref: '#/components/schemas/LogTree'
ArrayOfLogs:
description: A list of Log objects.
type: array
items:
$ref: '#/components/schemas/Log'
ArrayOfLogsResponse:
description: Response containing multiple logs.
type: object
properties:
data:
$ref: '#/components/schemas/ArrayOfLogs'
meta:
$ref: '#/components/schemas/ArrayOfLogsResponseMeta'
required:
- data
additionalProperties: false
ArrayOfLogsResponseMeta:
description: The metadata related to an array of logs response.
type: object
properties:
page:
$ref: '#/components/schemas/PaginationMeta'
required:
- page
additionalProperties: false
RunNumbers:
description: A serialized string of run numbers
type: string
example: "1,2,3,4,5,6,7,8"
ArrayOfRuns:
description: A list of Run objects.
type: array
items:
$ref: '#/components/schemas/Run'
ArrayOfRunsResponse:
description: Response containing multiple runs.
type: object
properties:
data:
$ref: '#/components/schemas/ArrayOfRuns'
meta:
$ref: '#/components/schemas/ArrayOfRunsResponseMeta'
required:
- data
additionalProperties: false
ArrayOfRunsResponseMeta:
description: The metadata related to an array of runs response.
type: object
properties:
page:
$ref: '#/components/schemas/PaginationMeta'
required:
- page
additionalProperties: false
ArrayOfSubsystems:
description: A list of Subsystem objects.
type: array
items:
$ref: '#/components/schemas/Subsystem'
ArrayOfSubsystemsResponse:
description: Response containing multiple subsystems.
type: object
properties:
data:
$ref: '#/components/schemas/ArrayOfSubsystems'
meta:
$ref: '#/components/schemas/ArrayOfSubsystemsResponseMeta'
required:
- data
additionalProperties: false
ArrayOfSubsystemsResponseMeta:
description: The metadata related to an array of subsystems response.
type: object
properties:
page:
$ref: '#/components/schemas/PaginationMeta'
required:
- page
additionalProperties: false
ArrayOfTags:
description: A list of Tag objects.
type: array
items:
$ref: '#/components/schemas/Tag'
ArrayOfTagsResponse:
description: Response containing multiple tags.
type: object
properties:
data:
$ref: '#/components/schemas/ArrayOfTags'
required:
- data
additionalProperties: false
Attachment:
description: Describes metadata of an attachment.
type: object
properties:
createdAt:
description: Unix timestamp when this entity was created.
type: integer
format: int64
example: 853113599
encoding:
$ref: '#/components/schemas/FileEncoding'
fileName:
$ref: '#/components/schemas/FileName'
id:
$ref: '#/components/schemas/EntityId'
logId:
$ref: '#/components/schemas/EntityId'
mimeType:
$ref: '#/components/schemas/FileMimeType'
originalName:
$ref: '#/components/schemas/FileOriginalName'
path:
$ref: '#/components/schemas/FilePath'
size:
$ref: '#/components/schemas/FileSize'
updatedAt:
description: Unix timestamp when this entity was created.
type: integer
format: int64
example: 853113599
required:
- id
additionalProperties: false
AttachmentResponse:
description: Response containing a single attachment.
type: object
properties:
data:
$ref: '#/components/schemas/Attachment'
required:
- data
additionalProperties: false
CommaSeparatedEntityIds:
description: CSV style string of EntityIds.
type: string
pattern: '^([1-9]+\d*,)*[1-9]+\d*$'
example: '1,2,3'
CreateAttachments:
description: Describes an attachment
type: object
properties:
attachments:
$ref: '#/components/schemas/ArrayOfAttachments'
additionalProperties: false
CreateFlp:
description: Describes an flp
type: object
properties:
name:
$ref: '#/components/schemas/FlpName'
hostname:
$ref: '#/components/schemas/FlpHostname'
runNumber:
$ref: '#/components/schemas/RunNumber'
required:
- name
- hostname
additionalProperties: false
CreateLog:
description: Describes an intervention or an event that happened.
type: object
properties:
attachments:
$ref: '#/components/schemas/ArrayOfAttachments'
parentLogId:
$ref: '#/components/schemas/EntityId'
text:
$ref: '#/components/schemas/LogText'
title:
$ref: '#/components/schemas/LogTitle'
runNumbers:
$ref: '#/components/schemas/RunNumbers'
required:
- text
- title
additionalProperties: false
CreateSubsystem:
description: A label attached to something for the purpose of identification.
type: object
properties:
text:
description: The label value of the subsystem.
type: string
required:
- text
additionalProperties: false
CreateTag:
description: A label attached to something for the purpose of identification.
type: object
properties:
text:
description: The label value of the tag.
type: string
required:
- text
additionalProperties: false
DeployInformation:
description: Deploy information
type: object
properties:
age:
description: The number of seconds that the server is online.
type: number
start:
description: The unix timestamp of the moment that the the server went online.
type: integer
format: int64
example: 853113599
required:
- age
- start
additionalProperties: false
Entity:
description: Base entity.
type: object
properties:
createdAt:
description: Unix timestamp when this entity was created.
type: integer
format: int64
example: 853113599
id:
$ref: '#/components/schemas/EntityId'
updatedAt:
description: Unix timestamp when this entity was last updated.
type: integer
format: int64
example: 853113599
required:
- id
EntityId:
description: The unique identifier of this entity.
type: integer
minimum: 1
Error:
description: An Error object.
type: object