-
Notifications
You must be signed in to change notification settings - Fork 19
/
microsetta_private_api.yaml
2089 lines (2042 loc) · 70.8 KB
/
microsetta_private_api.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:
description: Private Microsetta RESTful API
version: "0.3.0-oas3"
title: Private Microsetta RESTful API (OAS 3.0)
servers:
- url: '/api'
paths:
'/accounts':
get:
operationId: microsetta_private_api.api.find_accounts_for_login
tags:
- Account
summary: Retrieve an array of accounts accessible to the provided login
description: Retrieve an array of accounts accessible to the provided login
parameters:
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Array of accessible accounts
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/account'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
post:
operationId: microsetta_private_api.api.register_account
tags:
- Account
summary: Register new user account
description: Register new user account
parameters:
- $ref: '#/components/parameters/language_tag'
requestBody:
content:
application/json:
# Send (non-readOnly) values of account schema PLUS kit name
schema:
allOf:
- $ref: '#/components/schemas/account'
- type: "object"
properties:
kit_name:
$ref: '#/components/schemas/kit_name'
required:
- kit_name
responses:
'201':
description: Successfully registered new user account
headers:
Location:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/account'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
'/accounts/legacies':
post:
operationId: microsetta_private_api.api.claim_legacy_acct
tags:
- Account
summary: Claim any legacy accounts for this user's email and return an array of them
description: Claim any legacy accounts for this user's email and return an array of them
parameters:
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Successfully claimed legacy account(s)
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/account'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
'/accounts/{account_id}':
get:
operationId: microsetta_private_api.api.read_account
tags:
- Account
summary: Get user account information
description: Get user account information
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Successfully returned account information
content:
application/json:
schema:
$ref: '#/components/schemas/account'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
put:
operationId: microsetta_private_api.api.update_account
tags:
- Account
summary: Update user account information
description: Update user account information
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/language_tag'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/account'
responses:
'200':
description: Successfully updated user account information
content:
application/json:
schema:
$ref: '#/components/schemas/account'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
'/accounts/{account_id}/email_match':
get:
operationId: microsetta_private_api.api.check_email_match
tags:
- Account
summary: Check if email on microsetta account matches email on authentication account
description: Check if email on microsetta account matches email on authentication account
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Successfully returned email match status
content:
application/json:
schema:
type: object
properties:
email_match:
type: boolean
example: true
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'/accounts/{account_id}/consent':
get:
operationId: microsetta_private_api.api.render_consent_doc
tags:
- Consent
summary: Retrieve personalized consent form for display to user
description: Retrieve personalized consent form for display to user
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Consent form
content:
application/json:
schema:
type: object
properties:
add_human_title:
type: string
example: Add a New Human Source
sel_age_range:
type: string
example: Select age range of participant
age_0_6:
type: string
age_7_12:
type: string
age_12_17:
type: string
age_18:
type: string
consent_your_child:
type: string
participation_agreement:
type: string
exhibit_a:
type: string
bill_of_rights:
type: string
text_i_have_read_parent:
type: string
participant_name:
type: string
participant_email:
type: string
participant_parent_1:
type: string
participant_parent_2:
type: string
participant_deceased_parents:
type: string
assent_7_12:
type: string
text_i_have_read_simplified:
type: string
person_attaining_assent:
type: string
text_assent_witness:
type: string
obtainer_name:
type: string
assent_13_17:
type: string
text_i_have_read_1:
type: string
consent_18:
type: string
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
post:
operationId: microsetta_private_api.api.create_human_source_from_consent
tags:
- Source (from Consent)
summary: Create a new human source based on a consent form
description: Create a new human source based on a consent form
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/language_tag'
requestBody:
content:
application/json:
schema:
type: object
properties: # each is a form field name
age_range:
$ref: '#/components/schemas/age_range'
participant_name: # Field is named participant_name, but contents are used to fill source's name
$ref: '#/components/schemas/source_name'
participant_email:
$ref: '#/components/schemas/participant_email'
parent_1_name:
$ref: '#/components/schemas/parent_1_name'
parent_2_name:
$ref: '#/components/schemas/parent_2_name'
deceased_parent:
type: string
enum: ['true', 'false']
example: 'true'
obtainer_name:
$ref: '#/components/schemas/obtainer_name'
required:
- age_range
- participant_name
- participant_email
responses:
'201':
description: Successfully created new human source based on consent form
headers:
Location:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/human_source'
examples:
human_adult_source:
$ref: '#/components/examples/human_adult_source_w_id'
human_child_source:
$ref: '#/components/examples/human_child_source_w_id'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
'/accounts/{account_id}/sources':
get:
operationId: microsetta_private_api.api.read_sources
tags:
- Sources
summary: Get sources associated with account, filtered by source type if a source type is provided
description: Get sources associated with account, filtered by source type if a source type is provided
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_type'
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Successfully returned sources
content:
application/json:
schema:
type: array
items: # NB: return whole source objects, unless returning >5KB compressed data
oneOf:
- $ref: '#/components/schemas/human_source'
- $ref: '#/components/schemas/nonhuman_source'
example: # explicit examples hardcoded here because connexion can't seem to infer examples for lists
- source_id: "7cb1b4a9-5d42-42b2-9364-7bceb6630ac3"
source_name: "Ophelia Doe"
source_type: human
consent:
participant_email: "nunnery@example.com"
age_range: "18-plus"
- source_id: "df077cd7-f2c7-42e4-b8ed-9c7e9dd47ce5"
source_name: "P. Doe"
source_type: human
consent:
participant_email: "pomegranate@example.com"
age_range: "0-6"
child_info:
parent_1_name: "Demeter Doe"
parent_2_name: "Zeus Doe"
deceased_parent: false
obtainer_name: "Hades Doe"
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
post:
operationId: microsetta_private_api.api.create_source
tags:
- Source
summary: Create new source of a specific type
description: Create new source of a specific type
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/language_tag'
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/human_source'
- $ref: '#/components/schemas/nonhuman_source'
examples:
human_adult_source:
$ref: '#/components/examples/human_adult_source'
human_child_source:
$ref: '#/components/examples/human_child_source'
nonhuman_source:
$ref: '#/components/examples/nonhuman_source'
responses:
'201':
description: Successfully created new source
headers:
Location:
schema:
type: string
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/human_source'
- $ref: '#/components/schemas/nonhuman_source'
examples:
human_adult_source:
$ref: '#/components/examples/human_adult_source_w_id'
human_child_source:
$ref: '#/components/examples/human_child_source_w_id'
nonhuman_source:
$ref: '#/components/examples/nonhuman_source_w_id'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
'/accounts/{account_id}/sources/{source_id}':
get:
operationId: microsetta_private_api.api.read_source
tags:
- Source
summary: Get information about source
description: Get information about source
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Successfully returned source information
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/human_source'
- $ref: '#/components/schemas/nonhuman_source'
examples:
human_adult_source:
$ref: '#/components/examples/human_adult_source_w_id'
human_child_source:
$ref: '#/components/examples/human_child_source_w_id'
nonhuman_source:
$ref: '#/components/examples/nonhuman_source_w_id'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
put:
operationId: microsetta_private_api.api.update_source
tags:
- Source
summary: Update information for source
description: Update information for source
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/language_tag'
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/human_source'
- $ref: '#/components/schemas/nonhuman_source'
examples:
human_adult_source:
$ref: '#/components/examples/human_adult_source'
human_child_source:
$ref: '#/components/examples/human_child_source'
nonhuman_source:
$ref: '#/components/examples/nonhuman_source'
responses:
'200':
description: Successfully updated source information
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/human_source'
- $ref: '#/components/schemas/nonhuman_source'
examples:
human_adult_source:
$ref: '#/components/examples/human_adult_source_w_id'
human_child_source:
$ref: '#/components/examples/human_child_source_w_id'
nonhuman_source:
$ref: '#/components/examples/nonhuman_source_w_id'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
delete:
operationId: microsetta_private_api.api.delete_source
tags:
- Source
summary: Delete source
description: Delete source
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/language_tag'
responses:
'204':
description: Successfully deleted source
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
# NB: This would be returned if source cannot be deleted bc has a sample assigned to it
'/accounts/{account_id}/sources/{source_id}/survey_templates':
get:
operationId: microsetta_private_api.api.read_survey_templates
tags:
- Survey Templates
summary: Get survey templates available to this source
description: Get survey templates available to this source
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Successfully returned list of survey templates
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/thin_survey_template_info'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
# NB: No delete, put, or post for survey templates--can maybe expand to that for admin user in future
'/accounts/{account_id}/sources/{source_id}/survey_templates/{survey_template_id}':
get:
operationId: microsetta_private_api.api.read_survey_template
tags:
- Survey Template
summary: Get a particular survey template available to this source
description: Get a particular survey template available to this source
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/survey_template_id'
- $ref: '#/components/parameters/language_tag'
- $ref: '#/components/parameters/survey_redirect_url'
responses:
'200':
description: Successfully returned a specific survey template
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/thin_survey_template_info'
- type: "object"
properties:
survey_template_text:
$ref: '#/components/schemas/survey_template_text'
required:
- survey_template_text
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
# NB: No delete, put, or post for a particular survey template--can maybe expand to that for admin user in future
'/accounts/{account_id}/sources/{source_id}/surveys':
# NB: "survey" refers to an instance of an answered survey. In contrast, the set of *questions* comprising a survey
# is called a "survey template" (see elsewhere in this api)
get:
operationId: microsetta_private_api.api.read_answered_surveys
tags:
- Surveys (By Source)
summary: Get answered survey instances associated with source
description: Get answered survey instances associated with source
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Successfully returned list of answered surveys
content:
application/json:
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/thin_survey_template_info'
- type: "object"
properties:
survey_id:
$ref: '#/components/schemas/survey_id'
required:
- survey_id
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
post:
operationId: microsetta_private_api.api.submit_answered_survey
tags:
- Survey (By Source)
summary: Submit new answered survey
description: Submit new answered survey
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/language_tag'
requestBody:
content:
application/json:
schema:
type: object
properties:
survey_template_id:
$ref: '#/components/schemas/survey_template_id'
survey_text:
$ref: '#/components/schemas/survey_text'
responses:
'201':
description: Successfully submitted new answered survey
headers:
Location:
schema:
type: string
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
'/accounts/{account_id}/sources/{source_id}/surveys/{survey_id}':
get:
operationId: microsetta_private_api.api.read_answered_survey
tags:
- Survey (By Source)
summary: Get information about an answered survey
description: Get information about an answered survey
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/survey_id'
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Successfully returned information about answered survey
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/thin_survey_template_info'
- type: "object"
properties:
survey_id:
$ref: '#/components/schemas/survey_id'
survey_text:
$ref: '#/components/schemas/survey_text'
required:
- survey_id
- survey_text
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
# NB: NO "put"--you shouldn't update an answered survey, but instead should take a new one
# NB: Currently no delete ... can dissociate a survey from a sample but not delete the survey itself
'/accounts/{account_id}/sources/{source_id}/surveys/{survey_id}/reports/topfoodreport':
# Attempts to generate the vioscreen top food report pdf from this vioscreen survey
get:
# TODO: Unsure if this should be get or post- it's post on vioscreen, but
# we can't easily embed the pdf if the link is a post. May need to post
# and cache results so we can make it a get for embedding.
operationId: microsetta_private_api.api.top_food_report
tags:
- Survey
summary: Generate vioscreen top food report
description: Generate vioscreen top food report
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/survey_id'
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Top Food Report pdf
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'/accounts/{account_id}/sources/{source_id}/samples':
get:
operationId: microsetta_private_api.api.read_sample_associations
tags:
- Samples
summary: Get samples associated with this source
description: Get samples associated with this source
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Successfully returned list of samples
content:
application/json:
schema:
type: array
items: # Returning full samples instead of just ids as their info won't be large
$ref: '#/components/schemas/sample'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
post:
operationId: microsetta_private_api.api.associate_sample
tags:
- Sample
summary: Associate an unassociated sample with this source
description: Associate an unassociated sample with this source
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/language_tag'
requestBody:
content:
application/json:
schema:
type: object
properties:
sample_id:
# NB: Getting the sample id to input here is outside the scope of this endpoint--see kits
# NB: Can't use $ref: '#/components/schemas/sample_id' here because that is a readOnly property
# and thus is NOT SENT with posts (the readOnly functionality didn't really anticipate
# this use case of creating a new *association* rather than creating a new *object*).
type: string
example: "384fd128-3a42-4a6b-a37c-3fc3cbf027bc"
required:
- sample_id
responses:
'201':
description: Successfully associated sample with source
headers:
Location:
schema:
type: string
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
'/accounts/{account_id}/sources/{source_id}/samples/{sample_id}':
# NB: info about the sample--type, datetime, notes--does NOT exist *separate* from source association, so
# it can only be read/updated/deleted in the context of a source association
get:
operationId: microsetta_private_api.api.read_sample_association
tags:
- Sample
summary: Get information about a sample associated with this source
description: Get information about a sample associated with this source
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/sample_id'
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Successfully returned sample information
content:
application/json:
schema:
$ref: '#/components/schemas/sample'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
put:
operationId: microsetta_private_api.api.update_sample_association
tags:
- Sample
summary: Update information about a sample associated with this source
description: Update information about a sample associated with this source
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/sample_id'
- $ref: '#/components/parameters/language_tag'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/sample'
responses:
'200':
description: Successfully updated sample information
content:
application/json:
schema:
$ref: '#/components/schemas/sample'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'422':
# NB: This error would cover the case where you can't update a sample's info bc we already received it
$ref: '#/components/responses/422UnprocessableEntity'
delete:
tags:
- Sample
operationId: microsetta_private_api.api.dissociate_sample
summary: Dissociate a sample from a source and any of its associated surveys
description: Dissociate a sample from a source and any of its associated surveys
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/sample_id'
- $ref: '#/components/parameters/language_tag'
responses:
'204':
description: Sample was dissociated from source and source's surveys
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'422':
# NB: This error would cover the case where you can't dissociate it bc it was already processed
$ref: '#/components/responses/422UnprocessableEntity'
# NB: "surveys" is used as a path component in two different ways (here nested under sample and above nested
# directly under source. The dev team assessed this and decided this dual usage was not unacceptably confusing.
'/accounts/{account_id}/sources/{source_id}/samples/{sample_id}/surveys':
get:
operationId: microsetta_private_api.api.read_answered_survey_associations
tags:
- Surveys (By Sample)
summary: Get list of answered surveys associated with this sample
description: Get list of answered surveys associated with this sample
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/sample_id'
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Successfully returned list of answered surveys associated with this sample
content:
application/json:
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/thin_survey_template_info'
- type: "object"
properties:
survey_id:
$ref: '#/components/schemas/survey_id'
required:
- survey_id
example: # explicit examples hardcoded here because connexion can't seem to infer examples for lists
- survey_id: 1a7697cc-e202-4397-b12c-ab7e6d23bebd
survey_template_id: bb5ca7de-98ae-457c-99c5-419931824d1c
survey_template_title: "Food Frequency Questionnaire"
survey_template_version: "1.2"
survey_template_type: remote
- survey_id: a302f47c-8090-4ecd-b92f-14331b2807d3
survey_template_id: 2afb9f63-c733-4fc6-b2c4-e5ccac8331ff
survey_template_title: "Dream Survey"
survey_template_version: "0.1"
survey_template_type: local
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
post:
operationId: microsetta_private_api.api.associate_answered_survey
tags:
- Survey (By Sample)
summary: Associate an answered survey with this sample
description: Associate an answered survey with this sample
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/sample_id'
- $ref: '#/components/parameters/language_tag'
requestBody:
content:
application/json:
schema:
type: object
properties:
survey_id:
$ref: '#/components/schemas/survey_id'
responses:
'201':
description: Successfully associated answered survey with sample
headers:
Location:
schema:
type: string
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
'/accounts/{account_id}/sources/{source_id}/samples/{sample_id}/surveys/{survey_id}':
# NB: I can't really see a way that this can be updated, or even viewed--the association simply exists or doesn't
delete:
tags:
- Survey (By Sample)
operationId: microsetta_private_api.api.dissociate_answered_survey
summary: Dissociate an answered survey from a sample
description: Dissociate an answered survey from a sample
parameters:
- $ref: '#/components/parameters/account_id'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/sample_id'
- $ref: '#/components/parameters/survey_id'
- $ref: '#/components/parameters/language_tag'
responses:
'204':
description: Answered survey was dissociated from sample
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'/kits/':
get:
operationId: microsetta_private_api.api.read_kit
tags:
- Kit Samples
summary: Get list of samples in kit that are not assigned to a source
description: Get list of samples in kit that are not assigned to a source
parameters:
- $ref: '#/components/parameters/kit_name'
- $ref: '#/components/parameters/language_tag'
responses:
'200':
description: Successfully returned list of unassigned samples
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/sample'
'401':
$ref: '#/components/responses/401Unauthorized'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
# ADMINISTRATOR PATHS
'/admin/search/samples/{sample_barcode}':
get:
operationId: microsetta_private_api.admin.admin_impl.search_barcode
tags:
- Admin
summary: Retrieve diagnostic information about a sample by barcode