-
Notifications
You must be signed in to change notification settings - Fork 1
/
api-spec.yaml
1075 lines (1053 loc) · 27.7 KB
/
api-spec.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
components:
schemas:
ClearanceKeys:
properties:
autoproc_program:
items:
type: string
title: Autoproc Program
type: array
data_collection:
items:
type: string
title: Data Collection
type: array
data_collection_group:
items:
type: string
title: Data Collection Group
type: array
processing_job:
items:
type: string
title: Processing Job
type: array
required:
- data_collection_group
- data_collection
- processing_job
- autoproc_program
title: ClearanceKeys
type: object
ConnectionFileParameters:
properties:
destinations:
items:
type: string
title: Destinations
type: array
filename:
title: Filename
type: string
required:
- filename
- destinations
title: ConnectionFileParameters
type: object
ContextInfo:
properties:
acquisition_software:
title: Acquisition Software
type: string
experiment_type:
title: Experiment Type
type: string
required:
- experiment_type
- acquisition_software
title: ContextInfo
type: object
DCGroupParameters:
properties:
experiment_type:
title: Experiment Type
type: string
experiment_type_id:
title: Experiment Type Id
type: integer
tag:
title: Tag
type: string
required:
- experiment_type
- experiment_type_id
- tag
title: DCGroupParameters
type: object
DCParameters:
properties:
acquisition_software:
title: Acquisition Software
type: string
c2aperture:
title: C2Aperture
type: number
experiment_type:
title: Experiment Type
type: string
exposure_time:
title: Exposure Time
type: number
file_extension:
title: File Extension
type: string
image_directory:
title: Image Directory
type: string
image_size_x:
title: Image Size X
type: integer
image_size_y:
title: Image Size Y
type: integer
magnification:
title: Magnification
type: number
phase_plate:
default: false
title: Phase Plate
type: boolean
pixel_size_on_image:
title: Pixel Size On Image
type: string
slit_width:
title: Slit Width
type: number
source:
title: Source
type: string
tag:
title: Tag
type: string
total_exposed_dose:
title: Total Exposed Dose
type: number
voltage:
title: Voltage
type: number
required:
- voltage
- pixel_size_on_image
- experiment_type
- image_size_x
- image_size_y
- file_extension
- acquisition_software
- image_directory
- tag
- source
- magnification
title: DCParameters
type: object
File:
properties:
description:
title: Description
type: string
name:
title: Name
type: string
size:
title: Size
type: integer
timestamp:
title: Timestamp
type: number
required:
- name
- description
- size
- timestamp
title: File
type: object
GainReference:
properties:
gain_ref:
format: path
title: Gain Ref
type: string
required:
- gain_ref
title: GainReference
type: object
HTTPValidationError:
properties:
detail:
items:
$ref: "#/components/schemas/ValidationError"
title: Detail
type: array
title: HTTPValidationError
type: object
ProcessFile:
properties:
autoproc_program_id:
title: Autoproc Program Id
type: integer
data_collection_id:
title: Data Collection Id
type: integer
description:
title: Description
type: string
dose_per_frame:
title: Dose Per Frame
type: number
gain_ref:
title: Gain Ref
type: string
image_number:
title: Image Number
type: integer
mc_binning:
default: 1
title: Mc Binning
type: integer
mc_uuid:
title: Mc Uuid
type: integer
path:
title: Path
type: string
pixel_size:
title: Pixel Size
type: number
processing_job:
title: Processing Job
type: integer
size:
title: Size
type: integer
timestamp:
title: Timestamp
type: number
required:
- path
- description
- size
- timestamp
- processing_job
- data_collection_id
- image_number
- mc_uuid
- autoproc_program_id
- pixel_size
- dose_per_frame
title: ProcessFile
type: object
ProcessingJobParameters:
properties:
parameters:
default: {}
title: Parameters
type: object
recipe:
title: Recipe
type: string
tag:
title: Tag
type: string
required:
- tag
- recipe
title: ProcessingJobParameters
type: object
RegistrationMessage:
properties:
params:
title: Params
type: object
registration:
title: Registration
type: string
required:
- registration
title: RegistrationMessage
type: object
SPAProcessingParameters:
properties:
job_id:
title: Job Id
type: integer
required:
- job_id
title: SPAProcessingParameters
type: object
SuggestedPathParameters:
properties:
base_path:
format: path
title: Base Path
type: string
touch:
default: false
title: Touch
type: boolean
required:
- base_path
title: SuggestedPathParameters
type: object
TiltSeries:
properties:
autoproc_program_id:
title: Autoproc Program Id
type: integer
dcid:
title: Dcid
type: integer
file_tilt_list:
title: File Tilt List
type: string
manual_tilt_offset:
title: Manual Tilt Offset
type: integer
motion_corrected_path:
title: Motion Corrected Path
type: string
movie_id:
title: Movie Id
type: integer
name:
title: Name
type: string
pixel_size:
title: Pixel Size
type: number
processing_job:
title: Processing Job
type: integer
required:
- name
- file_tilt_list
- dcid
- processing_job
- autoproc_program_id
- motion_corrected_path
- movie_id
- pixel_size
- manual_tilt_offset
title: TiltSeries
type: object
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
title: Location
type: array
msg:
title: Message
type: string
type:
title: Error Type
type: string
required:
- loc
- msg
- type
title: ValidationError
type: object
Visit:
properties:
beamline:
title: Beamline
type: string
end:
format: date-time
title: End
type: string
name:
title: Name
type: string
proposal_title:
title: Proposal Title
type: string
session_id:
title: Session Id
type: integer
start:
format: date-time
title: Start
type: string
required:
- start
- end
- session_id
- name
- beamline
- proposal_title
title: Visit
type: object
info:
title: Murfey server
version: 0.1.0
openapi: 3.0.2
paths:
/:
get:
operationId: root__get
responses:
"200":
content:
text/html:
schema:
type: string
description: Successful Response
summary: Root
/bootstrap/:
get:
description:
"Return a website containing instructions for installing the Murfey
client on a
machine with no internet access."
operationId: get_bootstrap_instructions_bootstrap__get
responses:
"200":
content:
text/html:
schema:
type: string
description: Successful Response
summary: Get Bootstrap Instructions
tags:
- bootstrap
/bootstrap/murfey.whl:
get:
description:
"Return a wheel file containing the latest release version of Murfey.
We should
not have to worry about the exact Python compatibility here, as long as
murfey.bootstrap is compatible with all relevant versions of Python.
This also ignores yanked releases, which again should be fine."
operationId: get_murfey_wheel_bootstrap_murfey_whl_get
responses:
"200":
description: Successful Response
summary: Get Murfey Wheel
tags:
- bootstrap
/bootstrap/pip.whl:
get:
description:
"Return a static version of pip. This does not need to be the newest
or best,
but has to be compatible with all supported Python versions.
This is only used during bootstrapping by the client to identify and then
download the actually newest appropriate version of pip."
operationId: get_pip_wheel_bootstrap_pip_whl_get
responses:
"200":
description: Successful Response
summary: Get Pip Wheel
tags:
- bootstrap
/connections/:
get:
operationId: connections_check_connections__get
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
summary: Connections Check
/cygwin/setup-x86_64.exe:
get:
description:
"Obtain and past though a Cygwin installer from an official source.
This is used during client bootstrapping and can download and install the
Cygwin distribution that then remains on the client machines."
operationId: get_cygwin_setup_cygwin_setup_x86_64_exe_get
responses:
"200":
description: Successful Response
summary: Get Cygwin Setup
tags:
- bootstrap
/cygwin/{request_path}:
get:
description: Forward a Cygwin setup request to an official mirror.
operationId: parse_cygwin_request_cygwin__request_path__get
parameters:
- in: path
name: request_path
required: true
schema:
title: Request Path
type: string
responses:
"200":
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Parse Cygwin Request
tags:
- bootstrap
/demo/visits_raw:
get:
operationId: get_current_visits_demo_demo_visits_raw_get
responses:
"200":
content:
application/json:
schema:
items:
$ref: "#/components/schemas/Visit"
title: Response Get Current Visits Demo Demo Visits Raw Get
type: array
description: Successful Response
summary: Get Current Visits Demo
/feedback:
post:
operationId: send_murfey_message_feedback_post
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/RegistrationMessage"
required: true
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Send Murfey Message
/health/:
get:
operationId: health_check_health__get
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
summary: Health Check
/machine/:
get:
operationId: machine_info_machine__get
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
summary: Machine Info
/microscope/:
get:
operationId: get_mic_microscope__get
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
summary: Get Mic
/pypi/:
get:
description: Obtain list of all PyPI packages via the simple API (PEP 503).
operationId: get_pypi_index_pypi__get
responses:
"200":
description: Successful Response
summary: Get Pypi Index
tags:
- bootstrap
/pypi/{package}/:
get:
description:
"Obtain list of all package downloads from PyPI via the simple
API (PEP 503),
and rewrite all download URLs to point to this server,
underneath the current directory."
operationId: get_pypi_package_downloads_list_pypi__package___get
parameters:
- in: path
name: package
required: true
schema:
title: Package
type: string
responses:
"200":
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Get Pypi Package Downloads List
tags:
- bootstrap
/pypi/{package}/{filename}:
get:
description: Obtain and pass through a specific download for a PyPI package.
operationId: get_pypi_file_pypi__package___filename__get
parameters:
- in: path
name: package
required: true
schema:
title: Package
type: string
- in: path
name: filename
required: true
schema:
title: Filename
type: string
responses:
"200":
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Get Pypi File
tags:
- bootstrap
/version:
get:
operationId: get_version_version_get
parameters:
- in: query
name: client_version
required: false
schema:
default: ""
title: Client Version
type: string
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Get Version
/visits/:
get:
operationId: all_visit_info_visits__get
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
summary: All Visit Info
/visits/{visit_name}:
get:
operationId: visit_info_visits__visit_name__get
parameters:
- in: path
name: visit_name
required: true
schema:
title: Visit Name
type: string
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Visit Info
/visits/{visit_name}/align:
post:
operationId: request_tilt_series_alignment_visits__visit_name__align_post
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/TiltSeries"
required: true
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Request Tilt Series Alignment
/visits/{visit_name}/clean_state:
post:
operationId: clean_state_visits__visit_name__clean_state_post
parameters:
- in: path
name: visit_name
required: true
schema:
title: Visit Name
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ClearanceKeys"
required: true
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Clean State
/visits/{visit_name}/context:
post:
operationId: register_context_visits__visit_name__context_post
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ContextInfo"
required: true
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Register Context
/visits/{visit_name}/files:
post:
operationId: add_file_visits__visit_name__files_post
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/File"
required: true
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Add File
/visits/{visit_name}/process_gain:
post:
operationId: process_gain_visits__visit_name__process_gain_post
parameters:
- in: path
name: visit_name
required: true
schema:
title: Visit Name
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/GainReference"
required: true
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Process Gain
/visits/{visit_name}/register_data_collection_group:
post:
operationId: register_dc_group_visits__visit_name__register_data_collection_group_post
parameters:
- in: path
name: visit_name
required: true
schema:
title: Visit Name
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/DCGroupParameters"
required: true
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Register Dc Group
/visits/{visit_name}/register_processing_job:
post:
operationId: register_proc_visits__visit_name__register_processing_job_post
parameters:
- in: path
name: visit_name
required: true
schema:
title: Visit Name
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ProcessingJobParameters"
required: true
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Register Proc
/visits/{visit_name}/spa_processing:
post:
operationId: request_spa_processing_visits__visit_name__spa_processing_post
parameters:
- in: path
name: visit_name
required: true
schema:
title: Visit Name
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SPAProcessingParameters"
required: true
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Request Spa Processing
/visits/{visit_name}/start_data_collection:
post:
operationId: start_dc_visits__visit_name__start_data_collection_post
parameters:
- in: path
name: visit_name
required: true
schema:
title: Visit Name
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/DCParameters"
required: true
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Start Dc
/visits/{visit_name}/suggested_path:
post:
operationId: suggest_path_visits__visit_name__suggested_path_post
parameters:
- in: path
name: visit_name
required: true
schema:
title: Visit Name
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SuggestedPathParameters"
required: true
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Suggest Path
/visits/{visit_name}/tomography_preprocess:
post:
operationId: request_tomography_preprocessing_visits__visit_name__tomography_preprocess_post
parameters:
- in: path
name: visit_name
required: true
schema:
title: Visit Name
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ProcessFile"
required: true
responses:
"200":
content:
application/json:
schema: {}
description: Successful Response
"422":
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPValidationError"
description: Validation Error
summary: Request Tomography Preprocessing
/visits/{visit_name}/write_connections_file:
post:
operationId: write_conn_file_visits__visit_name__write_connections_file_post
parameters:
- in: path
name: visit_name
required: true
schema:
title: Visit Name
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectionFileParameters"
required: true
responses:
"200":