-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi3.yaml
More file actions
2688 lines (2688 loc) · 128 KB
/
openapi3.yaml
File metadata and controls
2688 lines (2688 loc) · 128 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
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.3
info:
title: LFX V2 - Survey Service
description: Proxy service for ITX survey system
version: "1.0"
servers:
- url: http://localhost:8080
paths:
/surveys:
post:
tags:
- survey
summary: schedule_survey survey
description: Create a scheduled survey for ITX project committee (proxies to ITX POST /surveys/schedule)
operationId: survey#schedule_survey
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleSurveyRequestBody'
example:
committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
committee_voting_enabled: true
creator_id: Quam esse saepe eum non omnis amet.
creator_name: Consequatur quod numquam et provident dolorem voluptatem.
creator_username: Numquam eum suscipit labore odio rerum.
email_body: Repellendus sunt omnis voluptate minima possimus.
email_body_text: Occaecati sunt odit quia quia fugiat est.
email_subject: Quis vero voluptatem et temporibus.
is_project_survey: true
send_immediately: true
stage_filter: Dolorem quia et in.
survey_cutoff_date: Omnis sint reprehenderit.
survey_monkey_id: Omnis est at omnis.
survey_reminder_rate_days: 3291766316701683331
survey_send_date: Et nulla quia.
survey_title: Dolorum cumque.
responses:
"201":
description: Created response.
content:
application/json:
schema:
$ref: '#/components/schemas/SurveyScheduleResult'
example:
committee_category: Perferendis facilis minima.
committee_voting_enabled: false
committees:
- committee_name: Technical Steering Committee
committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
nps_value: 0.6266969501277094
project_name: Kubernetes
project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
survey_url: https://surveymonkey.com/r/abc123
total_recipients: 256525687450027157
total_responses: 8506409821911103766
- committee_name: Technical Steering Committee
committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
nps_value: 0.6266969501277094
project_name: Kubernetes
project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
survey_url: https://surveymonkey.com/r/abc123
total_recipients: 256525687450027157
total_responses: 8506409821911103766
- committee_name: Technical Steering Committee
committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
nps_value: 0.6266969501277094
project_name: Kubernetes
project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
survey_url: https://surveymonkey.com/r/abc123
total_recipients: 256525687450027157
total_responses: 8506409821911103766
created_at: "1997-02-08T02:16:04Z"
creator_id: Aliquam quia.
creator_name: Sed consequatur magnam sit cumque.
creator_username: Quibusdam perferendis perferendis expedita molestiae asperiores autem.
email_body: Ex facere adipisci voluptatibus sapiente quidem.
email_body_text: Odio quam voluptatibus quod.
email_subject: Deleniti alias dolor ut voluptatem.
is_nps_survey: false
is_project_survey: false
last_modified_at: "1990-04-28T05:27:55Z"
last_modified_by: Non eos occaecati eveniet ut est.
latest_automated_reminder_sent_at: "1986-11-23T12:12:35Z"
next_automated_reminder_at: "1990-01-15T20:28:07Z"
nps_value: 0.8489560388638391
num_automated_reminders_sent: 2546153251221068036
num_automated_reminders_to_send: 1987383043001567865
num_detractors: 6722206839176231374
num_passives: 7797190939681643122
num_promoters: 8175617102193956655
response_status: scheduled
send_immediately: false
stage_filter: Mollitia necessitatibus incidunt.
survey_cutoff_date: "2008-07-25T14:18:55Z"
survey_monkey_id: Quas eveniet eaque dicta.
survey_reminder_rate_days: 2793305353261564275
survey_send_date: "1983-04-29T16:58:00Z"
survey_status: scheduled
survey_title: Iure explicabo explicabo ut dolorem.
survey_url: Et atque quaerat.
total_bounced_emails: 5809701518566913218
total_recipients: 8249359941071894662
total_responses: 6838673830197443373
uid: 4e8165a9-9b29-4506-b093-ab0a4aae9b84
"400":
description: 'BadRequest: Bad request'
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
example:
code: Reiciendis voluptas magni itaque.
message: Ab magnam officia et.
"401":
description: 'Unauthorized: Unauthorized'
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
example:
code: Sit qui aut cupiditate illum eum.
message: Voluptas quis qui quo.
"403":
description: 'Forbidden: Forbidden'
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
example:
code: Rem labore quisquam perspiciatis.
message: Blanditiis sed unde incidunt.
"500":
description: 'InternalServerError: Internal server error'
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
example:
code: Reiciendis quis dignissimos.
message: Nostrum et.
"503":
description: 'ServiceUnavailable: Service unavailable'
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableError'
example:
code: Rerum ut quis incidunt.
message: Eum explicabo error.
security:
- jwt_header_Authorization:
- manage:projects
- manage:surveys
/surveys/{survey_uid}:
delete:
tags:
- survey
summary: delete_survey survey
description: Delete survey (proxies to ITX DELETE /v2/surveys/{survey_uid}). Only allowed when status is 'disabled'
operationId: survey#delete_survey
parameters:
- name: survey_uid
in: path
description: Survey identifier
required: true
schema:
type: string
description: Survey identifier
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
responses:
"204":
description: No Content response.
"400":
description: 'BadRequest: Bad request'
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
example:
code: Sed laborum similique.
message: Sunt voluptatem deserunt fugiat dicta.
"401":
description: 'Unauthorized: Unauthorized'
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
example:
code: Et laudantium.
message: Facilis impedit ea placeat maxime.
"403":
description: 'Forbidden: Forbidden'
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
example:
code: Fuga corrupti nesciunt.
message: Id assumenda aliquid tenetur iste maxime.
"404":
description: 'NotFound: Not found'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
example:
code: Ut nisi cupiditate quam.
message: Similique quibusdam voluptates quis.
"500":
description: 'InternalServerError: Internal server error'
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
example:
code: Consequuntur eum.
message: Rerum voluptatem.
"503":
description: 'ServiceUnavailable: Service unavailable'
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableError'
example:
code: Consectetur at est nemo.
message: Excepturi enim molestias reiciendis ut.
security:
- jwt_header_Authorization:
- manage:projects
- manage:surveys
get:
tags:
- survey
summary: get_survey survey
description: Get survey details (proxies to ITX GET /v2/surveys/{survey_uid})
operationId: survey#get_survey
parameters:
- name: project_uid
in: query
description: Optional LFX Project UID (V2) to filter survey data
allowEmptyValue: true
schema:
type: string
description: Optional LFX Project UID (V2) to filter survey data
example: qa1e8536-a985-4cf5-b981-a170927a1d11
example: qa1e8536-a985-4cf5-b981-a170927a1d11
- name: project_uids
in: query
description: Optional comma-delimited list of LFX Project UIDs (V2). Should not be combined with project_uid
allowEmptyValue: true
schema:
type: string
description: Optional comma-delimited list of LFX Project UIDs (V2). Should not be combined with project_uid
example: qa1e8536-a985-4cf5-b981-a170927a1d11,qa1e8536-a985-4cf5-b981-a170927a1d12
example: qa1e8536-a985-4cf5-b981-a170927a1d11,qa1e8536-a985-4cf5-b981-a170927a1d12
- name: survey_uid
in: path
description: Survey identifier
required: true
schema:
type: string
description: Survey identifier
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
responses:
"200":
description: OK response.
content:
application/json:
schema:
$ref: '#/components/schemas/SurveyScheduleResult'
example:
committee_category: Sed ut.
committee_voting_enabled: false
committees:
- committee_name: Technical Steering Committee
committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
nps_value: 0.6266969501277094
project_name: Kubernetes
project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
survey_url: https://surveymonkey.com/r/abc123
total_recipients: 256525687450027157
total_responses: 8506409821911103766
- committee_name: Technical Steering Committee
committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
nps_value: 0.6266969501277094
project_name: Kubernetes
project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
survey_url: https://surveymonkey.com/r/abc123
total_recipients: 256525687450027157
total_responses: 8506409821911103766
created_at: "1990-05-26T18:10:13Z"
creator_id: Facilis est.
creator_name: Laborum fuga dolores inventore sit est sed.
creator_username: In autem provident blanditiis ab officiis ipsum.
email_body: Quis mollitia ut minus.
email_body_text: Sed ipsum nobis in aut similique.
email_subject: Vitae unde.
is_nps_survey: false
is_project_survey: false
last_modified_at: "1994-01-14T00:41:21Z"
last_modified_by: Culpa consequatur aut.
latest_automated_reminder_sent_at: "1979-03-13T23:58:59Z"
next_automated_reminder_at: "1983-11-22T04:37:25Z"
nps_value: 0.6379567056920531
num_automated_reminders_sent: 5955312177100105707
num_automated_reminders_to_send: 1501073311041553136
num_detractors: 2100042836277055694
num_passives: 4696138859968207767
num_promoters: 8946836443250022414
response_status: scheduled
send_immediately: false
stage_filter: Ab mollitia possimus et eum vero omnis.
survey_cutoff_date: "1991-03-10T03:13:24Z"
survey_monkey_id: Perspiciatis iste aut sit fugit.
survey_reminder_rate_days: 8773992317131132630
survey_send_date: "1992-05-28T13:28:36Z"
survey_status: scheduled
survey_title: Quis distinctio quae.
survey_url: Aliquam in aut laborum quod esse qui.
total_bounced_emails: 7455921900934456301
total_recipients: 5590032177824588820
total_responses: 2896297817607758689
uid: 4e8165a9-9b29-4506-b093-ab0a4aae9b84
"400":
description: 'BadRequest: Bad request'
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
example:
code: Consequuntur inventore vel vel.
message: Inventore quis voluptas dolore qui.
"401":
description: 'Unauthorized: Unauthorized'
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
example:
code: Saepe sed temporibus et est.
message: Maiores dolorem aut odit dolorem repudiandae est.
"403":
description: 'Forbidden: Forbidden'
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
example:
code: Hic dolorem atque alias possimus eum qui.
message: Molestiae quaerat voluptas.
"404":
description: 'NotFound: Not found'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
example:
code: Et dolorem reprehenderit.
message: Ut suscipit assumenda.
"500":
description: 'InternalServerError: Internal server error'
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
example:
code: Inventore a fuga ut aut nostrum.
message: Cumque architecto laboriosam minus.
"503":
description: 'ServiceUnavailable: Service unavailable'
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableError'
example:
code: Voluptatem nihil.
message: Quisquam quas veniam sequi ea quia.
security:
- jwt_header_Authorization:
- manage:projects
- manage:surveys
put:
tags:
- survey
summary: update_survey survey
description: Update survey (proxies to ITX PUT /v2/surveys/{survey_uid}). Only allowed when status is 'disabled'
operationId: survey#update_survey
parameters:
- name: survey_uid
in: path
description: Survey identifier
required: true
schema:
type: string
description: Survey identifier
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSurveyRequestBody'
example:
committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
committee_voting_enabled: true
creator_id: Qui distinctio dolorum quia non quaerat nostrum.
email_body: Veniam consequuntur sed praesentium.
email_body_text: Similique et sapiente sunt sit.
email_subject: Quo omnis maiores impedit.
survey_cutoff_date: Consequatur rem et voluptatem et.
survey_reminder_rate_days: 464515454408226755
survey_send_date: Sed in perspiciatis odit nesciunt.
survey_title: Ut dicta eum ut vero animi.
responses:
"200":
description: OK response.
content:
application/json:
schema:
$ref: '#/components/schemas/SurveyScheduleResult'
example:
committee_category: Veritatis nisi quasi totam nostrum.
committee_voting_enabled: true
committees:
- committee_name: Technical Steering Committee
committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
nps_value: 0.6266969501277094
project_name: Kubernetes
project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
survey_url: https://surveymonkey.com/r/abc123
total_recipients: 256525687450027157
total_responses: 8506409821911103766
- committee_name: Technical Steering Committee
committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
nps_value: 0.6266969501277094
project_name: Kubernetes
project_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
survey_url: https://surveymonkey.com/r/abc123
total_recipients: 256525687450027157
total_responses: 8506409821911103766
created_at: "2012-11-29T16:25:11Z"
creator_id: Eos autem aut cum nesciunt.
creator_name: Dolores corporis debitis harum earum autem et.
creator_username: Modi excepturi et quas.
email_body: Vero impedit doloribus saepe.
email_body_text: Perspiciatis saepe culpa in dolores quam.
email_subject: Error quisquam qui veritatis temporibus sit illum.
is_nps_survey: false
is_project_survey: true
last_modified_at: "2000-06-29T14:09:13Z"
last_modified_by: Possimus iure sint et sunt amet aut.
latest_automated_reminder_sent_at: "1999-02-24T22:35:21Z"
next_automated_reminder_at: "2007-11-22T23:43:56Z"
nps_value: 0.23141298976984814
num_automated_reminders_sent: 8337289837672265763
num_automated_reminders_to_send: 8107375938073788662
num_detractors: 8419714383430859074
num_passives: 3773156406319571058
num_promoters: 7275587620146515160
response_status: scheduled
send_immediately: false
stage_filter: Sit id modi corporis.
survey_cutoff_date: "1981-11-20T11:20:01Z"
survey_monkey_id: Sed eligendi quo qui sint doloremque.
survey_reminder_rate_days: 3045289415844103173
survey_send_date: "1976-11-13T06:51:25Z"
survey_status: scheduled
survey_title: Quo tempore porro.
survey_url: Reprehenderit qui.
total_bounced_emails: 920116411734754744
total_recipients: 7053772202910532748
total_responses: 3641612096555752497
uid: 4e8165a9-9b29-4506-b093-ab0a4aae9b84
"400":
description: 'BadRequest: Bad request'
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
example:
code: Voluptas sit ea.
message: Est earum voluptatem eos corporis.
"401":
description: 'Unauthorized: Unauthorized'
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
example:
code: Sit veniam.
message: Facere perferendis.
"403":
description: 'Forbidden: Forbidden'
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
example:
code: Et eveniet reprehenderit.
message: Inventore rerum quisquam in dolorem.
"404":
description: 'NotFound: Not found'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
example:
code: Repudiandae distinctio consequuntur nam maiores omnis perspiciatis.
message: Et et illum et.
"500":
description: 'InternalServerError: Internal server error'
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
example:
code: Laboriosam excepturi perferendis maiores ullam est.
message: Qui alias beatae libero totam.
"503":
description: 'ServiceUnavailable: Service unavailable'
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableError'
example:
code: Est aut.
message: Placeat error dolore molestiae.
security:
- jwt_header_Authorization:
- manage:projects
- manage:surveys
/surveys/{survey_uid}/bulk_resend:
post:
tags:
- survey
summary: bulk_resend_survey survey
description: Bulk resend survey emails to select recipients (proxies to ITX POST /v2/surveys/{survey_uid}/bulk_resend)
operationId: survey#bulk_resend_survey
parameters:
- name: survey_uid
in: path
description: Survey identifier
required: true
schema:
type: string
description: Survey identifier
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BulkResendSurveyRequestBody'
example:
recipient_ids:
- cba14f40-1636-11ec-9621-0242ac130002
- cba14f40-1636-11ec-9621-0242ac130003
responses:
"204":
description: No Content response.
"400":
description: 'BadRequest: Bad request'
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
example:
code: Quo porro et quam molestias excepturi.
message: Fuga voluptatem aperiam ut delectus veritatis.
"401":
description: 'Unauthorized: Unauthorized'
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
example:
code: Quasi molestias fugiat laudantium.
message: Et voluptatem est.
"403":
description: 'Forbidden: Forbidden'
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
example:
code: Quia necessitatibus maxime aperiam voluptatum et.
message: Delectus totam et quaerat.
"404":
description: 'NotFound: Not found'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
example:
code: Laudantium rerum inventore sed quis.
message: Mollitia explicabo inventore est dolorum omnis et.
"500":
description: 'InternalServerError: Internal server error'
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
example:
code: Velit velit a officiis voluptas porro.
message: Quas in illum qui at hic necessitatibus.
"503":
description: 'ServiceUnavailable: Service unavailable'
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableError'
example:
code: Non ut.
message: Aut delectus.
security:
- jwt_header_Authorization:
- manage:projects
- manage:surveys
/surveys/{survey_uid}/preview_send:
get:
tags:
- survey
summary: preview_send_survey survey
description: Preview which recipients, committees, and projects would be affected by a resend (proxies to ITX GET /v2/surveys/{survey_uid}/preview_send)
operationId: survey#preview_send_survey
parameters:
- name: committee_uid
in: query
description: Optional committee UID to filter preview
allowEmptyValue: true
schema:
type: string
description: Optional committee UID to filter preview
example: qa1e8536-a985-4cf5-b981-a170927a1d11
example: qa1e8536-a985-4cf5-b981-a170927a1d11
- name: survey_uid
in: path
description: Survey identifier
required: true
schema:
type: string
description: Survey identifier
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
responses:
"200":
description: OK response.
content:
application/json:
schema:
$ref: '#/components/schemas/PreviewSendResult'
example:
affected_committees:
- committee_category: Technical Steering Committee
committee_name: Technical Steering Committee
committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
project_name: Kubernetes
project_uid: 003170000123XHTAA2
- committee_category: Technical Steering Committee
committee_name: Technical Steering Committee
committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
project_name: Kubernetes
project_uid: 003170000123XHTAA2
- committee_category: Technical Steering Committee
committee_name: Technical Steering Committee
committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
project_name: Kubernetes
project_uid: 003170000123XHTAA2
- committee_category: Technical Steering Committee
committee_name: Technical Steering Committee
committee_uid: qa1e8536-a985-4cf5-b981-a170927a1d11
project_name: Kubernetes
project_uid: 003170000123XHTAA2
affected_projects:
- id: 003170000123XHTAA2
logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut.
name: Express JS
slug: express-gateway
status: Active
- id: 003170000123XHTAA2
logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut.
name: Express JS
slug: express-gateway
status: Active
- id: 003170000123XHTAA2
logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut.
name: Express JS
slug: express-gateway
status: Active
- id: 003170000123XHTAA2
logo_url: Eveniet earum nesciunt dicta quidem voluptatem aut.
name: Express JS
slug: express-gateway
status: Active
affected_recipients:
- email: john.doe@example.com
first_name: John
last_name: Doe
name: John Doe
role: Voting Rep
user_id: 005f1000009RbC4AAK
username: jdoe
- email: john.doe@example.com
first_name: John
last_name: Doe
name: John Doe
role: Voting Rep
user_id: 005f1000009RbC4AAK
username: jdoe
- email: john.doe@example.com
first_name: John
last_name: Doe
name: John Doe
role: Voting Rep
user_id: 005f1000009RbC4AAK
username: jdoe
"400":
description: 'BadRequest: Bad request'
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
example:
code: Quod illum.
message: Aliquam harum.
"401":
description: 'Unauthorized: Unauthorized'
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
example:
code: Dolores maxime accusantium perferendis itaque omnis provident.
message: Officiis hic quis.
"403":
description: 'Forbidden: Forbidden'
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
example:
code: Enim omnis ad.
message: Voluptas repellat hic atque aut.
"404":
description: 'NotFound: Not found'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
example:
code: Beatae omnis explicabo sunt qui dolores laborum.
message: Vero quia corporis ut.
"500":
description: 'InternalServerError: Internal server error'
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
example:
code: Aut id mollitia voluptas aut maiores.
message: Libero dolore non quos est autem.
"503":
description: 'ServiceUnavailable: Service unavailable'
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableError'
example:
code: Explicabo eius voluptates in asperiores ducimus aut.
message: Adipisci consequatur sapiente at.
security:
- jwt_header_Authorization:
- manage:projects
- manage:surveys
/surveys/{survey_uid}/recipient_group:
delete:
tags:
- survey
summary: delete_recipient_group survey
description: Remove a recipient group (committee, project, or foundation) from survey and recalculate statistics (proxies to ITX DELETE /v2/surveys/{survey_uid}/recipient_group)
operationId: survey#delete_recipient_group
parameters:
- name: committee_uid
in: query
description: Committee UID to remove (indicates specific committee in project)
allowEmptyValue: true
schema:
type: string
description: Committee UID to remove (indicates specific committee in project)
example: qa1e8536-a985-4cf5-b981-a170927a1d11
example: qa1e8536-a985-4cf5-b981-a170927a1d11
- name: project_uid
in: query
description: Project UID to remove (all removals are attached to a project)
allowEmptyValue: true
schema:
type: string
description: Project UID to remove (all removals are attached to a project)
example: 003170000123XHTAA2
example: 003170000123XHTAA2
- name: foundation_id
in: query
description: Foundation ID (indicates project_uid references a foundation and all subprojects should be removed)
allowEmptyValue: true
schema:
type: string
description: Foundation ID (indicates project_uid references a foundation and all subprojects should be removed)
example: 003170000123XHTAA2
example: 003170000123XHTAA2
- name: survey_uid
in: path
description: Survey identifier
required: true
schema:
type: string
description: Survey identifier
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
responses:
"204":
description: No Content response.
"400":
description: 'BadRequest: Bad request'
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
example:
code: Iusto voluptates est recusandae.
message: Corrupti eos repudiandae.
"401":
description: 'Unauthorized: Unauthorized'
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
example:
code: Deserunt ex et esse aut quo corporis.
message: Animi laboriosam.
"403":
description: 'Forbidden: Forbidden'
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
example:
code: Illum aspernatur animi maxime est et.
message: Eius ratione nisi facere.
"404":
description: 'NotFound: Not found'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
example:
code: Enim placeat harum voluptatem.
message: Sed voluptatibus doloribus optio in sit reprehenderit.
"500":
description: 'InternalServerError: Internal server error'
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
example:
code: Iusto autem.
message: Qui sequi repudiandae est alias nisi doloremque.
"503":
description: 'ServiceUnavailable: Service unavailable'
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableError'
example:
code: In cum ipsa aliquam.
message: Nisi qui repudiandae omnis molestiae assumenda.
security:
- jwt_header_Authorization:
- manage:projects
- manage:surveys
/surveys/{survey_uid}/responses/{response_id}:
delete:
tags:
- survey
summary: delete_survey_response survey
description: Delete survey response - removes recipient from survey and recalculates statistics (proxies to ITX DELETE /v2/surveys/{survey_uid}/responses/{response_id})
operationId: survey#delete_survey_response
parameters:
- name: survey_uid
in: path
description: Survey identifier
required: true
schema:
type: string
description: Survey identifier
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
- name: response_id
in: path
description: Response identifier
required: true
schema:
type: string
description: Response identifier
example: cba14f40-1636-11ec-9621-0242ac130002
example: cba14f40-1636-11ec-9621-0242ac130002
responses:
"204":
description: No Content response.
"400":
description: 'BadRequest: Bad request'
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
example:
code: Consectetur modi quisquam non a omnis.
message: Incidunt veritatis molestiae molestiae temporibus rerum.
"401":
description: 'Unauthorized: Unauthorized'
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
example:
code: Laborum impedit sed minima molestiae.
message: Non quisquam ea earum.
"403":
description: 'Forbidden: Forbidden'
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
example:
code: Non ea necessitatibus ut.
message: Possimus et aut repudiandae beatae autem repellendus.
"404":
description: 'NotFound: Not found'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
example:
code: Rerum dolores enim distinctio rerum eius earum.
message: Assumenda enim culpa.
"500":
description: 'InternalServerError: Internal server error'
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
example:
code: Reiciendis facilis sunt.
message: Eum possimus laudantium aut pariatur qui provident.
"503":
description: 'ServiceUnavailable: Service unavailable'
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableError'
example:
code: Eligendi quasi doloremque quidem.
message: Est ducimus ut omnis et.
security:
- jwt_header_Authorization:
- manage:projects
- manage:surveys
/surveys/{survey_uid}/responses/{response_id}/resend:
post:
tags:
- survey
summary: resend_survey_response survey
description: Resend survey email to a specific user (proxies to ITX POST /v2/surveys/{survey_uid}/responses/{response_id}/resend)
operationId: survey#resend_survey_response
parameters:
- name: survey_uid
in: path
description: Survey identifier
required: true
schema:
type: string
description: Survey identifier
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
example: b03cdbaf-53b1-4d47-bc04-dd7e459dd309
- name: response_id
in: path
description: Response identifier
required: true
schema:
type: string
description: Response identifier
example: cba14f40-1636-11ec-9621-0242ac130002
example: cba14f40-1636-11ec-9621-0242ac130002
responses:
"204":