This repository has been archived by the owner on Sep 11, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathchaosplatform-openapi.yaml
1695 lines (1660 loc) · 47.8 KB
/
chaosplatform-openapi.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.2"
info:
title: Chaos Platform Open API
version: 0.1.0
contact:
name: Chaos Toolkit
url: 'https://chaostoolkit.org'
email: [email protected]
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
description: |
This OpenAPI is the public HTTP API of the Chaos Platform.
Currently it is meant to handle the basic resources exposed by the Chaos
Platform:
* Users
* Organizations, Workspaces
* Access Token
* Experiment, Execution
* Scheduling
* Policies
If you are interested, please contribute to the discussion on the
issue at https://github.com/chaostoolkit/chaoshub/issues/3
Some points to keep in mind:
* It should be possible to create/delete all resources at the root leve
of the API. For instance, while an experiment lives in a workspace. It
should be possible to create the experiment like this,
`POST /api/v1/experiment`, rather than
`POST /api/v1/workspace/{workspace_id}/experiment`. The rationale is that
resources exist notwhithstanding where they are logically grouped. In
effect, we decouple how resources related with each other from their
existence.
* Resources are identified using a UUID. While UUID have their short
comings, they are portable and well-supported by all languages. They must
be considered as opaque strings however and their high-cardinality should
be understood. Note also that OpenAPI does not officially specify a uuid
type, so we must fallback to declare them as strings in this
specification.
* Registration of a new user is performed out of band from this API. In,
other words, to use this API you must have created an account via the
web interface and, at least, one access token. Then, with that token, you
can start calling this API.
* This API does not expose a `/reporting` endpoint because extracting data
is often a consumer concern (filters...) that can't easily be expressed
via a REST API. Instead, this will be exposed as a GraphQL endpoint.
* The policy resource is very much under specified here and requires a lot
more thoughts, but it provides a starting point for discussing what
policing chaos experiment means for an organization.
tags:
- name: Organization
description: |
An organization is a grouping entity used to sort your experiments, and
their executions, into workspaces. In other word, organizations contain
workspaces which, in turn, holds experiments and executions.
You could use an organization per team and one workspace per project for
that team. Or the other way around. It's up to you to make a decision
how you wish to categorize and triage your experiments.
Notice, no two organizations can have the same name.
- name: Workspace
description: |
A workspace is a grouping entity used to triage your experiments and
their executions.
Notice, no two workspaces can have the same name within a given
organization.
- name: Experiment
externalDocs:
url: https://docs.chaostoolkit.org/reference/api/experiment/
- name: Execution
description: |
An execution is a single run of an experiment. It contains metadata about
the run, such as its date and duration but also the journal, as per the
Chaos Toolkit specification.
externalDocs:
url: https://docs.chaostoolkit.org/reference/api/journal/
- name: Scheduling
description: |
A scheduling represents the incarnation of a set of planned executions.
A scheduling may be paused/resumed, cancelled.
- name: Policy
description: |
A policy describes conditions, scoping and context for a resource such
as the experiment or scheduling. For the former, it is used to express
the blast radius of the experiment, e.g. the functional perimeter of the
experiment. For the scheduling, the policy describes how a scheduling
can co-exist with other schedulings, for instance, preventing
other schedulings to take place at a given moment.
servers:
- url: http://localhost:8080/api/v1
paths:
/auth/tokens:
get:
tags:
- Authorization
operationId: servertck.list_tokens
summary: List all tokens for the authenticated user
responses:
'401':
description: Unauthenticated
'200':
description: List of access tokens the user owns
content:
application/json:
schema:
$ref: '#/components/schemas/AccessTokens'
x-code-samples:
- lang: 'cURL'
source: |
curl -H "Authorization: Bearer TOKEN" \
-H "Accept: application/json" \
"https://localhost:8080/api/v1/auth/tokens"
- lang: 'Python'
source: |
import requests
bearer_token = "..."
response = requests.get(
"https://localhost:8080/api/v1/auth/tokens",
headers={
"Authorization": f"Bearer {bearer_token}",
"Accept": "application/json"
}
)
tokens = response.json()
post:
tags:
- Authorization
operationId: servertck.create_token
summary: Create a new access token for the given user
responses:
'401':
description: Unauthenticated
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/AccessToken'
'409':
description: Name already used for another of the user's tokens
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: Payload error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
description: Token name and the user to add the new token to
content:
application/json:
schema:
$ref: '#/components/schemas/NewAccessToken'
x-code-samples:
- lang: 'cURL'
source: |
curl -X POST -H "Authorization: Bearer TOKEN" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"name": "my-new-token",
"user_id": "USER_ID_UUID"
}' \
"https://localhost:8080/api/v1/auth/tokens"
- lang: 'Python'
source: |
import requests
bearer_token = "..."
user_id = "USER ID UUID"
response = requests.post(
"https://localhost:8080/api/v1/auth/tokens",
headers={
"Authorization": f"Bearer {bearer_token}",
"Accept": "application/json"
"Content-Type": "application/json"
},
json={
"name": "my-new-token",
"user_id": f"{user_id}"
}
)
token = response.json()
/auth/tokens/{token_id}:
get:
tags:
- Authorization
operationId: servertck.get_token
summary: Get the token
parameters:
- $ref: '#/components/parameters/TokenId'
responses:
'401':
description: Unauthenticated
'200':
description: The access token owned by the user
content:
application/json:
schema:
$ref: '#/components/schemas/AccessToken'
x-code-samples:
- lang: 'cURL'
source: |
curl -H "Authorization: Bearer TOKEN" \
-H "Accept: application/json" \
"https://localhost:8080/api/v1/auth/tokens/TOKEN_UUID"
- lang: 'Python'
source: |
import requests
bearer_token = "..."
token_uuid = ""
response = requests.get(
f"https://localhost:8080/api/v1/auth/tokens/{token_uuid}",
headers={
"Authorization": f"Bearer {bearer_token}",
"Accept": "application/json"
}
)
token = response.json()
delete:
tags:
- Authorization
operationId: servertck.delete_token
summary: Delete the token
parameters:
- $ref: '#/components/parameters/TokenId'
responses:
'401':
description: Unauthenticated
'204':
description: The access token is deleted
x-code-samples:
- lang: 'cURL'
source: |
curl -XDELETE -H "Authorization: Bearer TOKEN" \
-H "Accept: application/json" \
"https://localhost:8080/api/v1/auth/tokens/TOKEN_UUID"
- lang: 'Python'
source: |
import requests
bearer_token = "..."
token_uuid = ""
response = requests.delete(
f"https://localhost:8080/api/v1/auth/tokens/{token_uuid}",
headers={
"Authorization": f"Bearer {bearer_token}",
"Accept": "application/json"
}
)
/organizations:
get:
tags:
- Organization
operationId: servertck.list_orgs
summary: List all organizations the authenticated user has access to
responses:
'401':
description: Unauthenticated
'200':
description: A list of organizations
content:
application/json:
schema:
$ref: '#/components/schemas/Organizations'
x-code-samples:
- lang: 'cURL'
source: |
curl -H "Authorization: Bearer TOKEN" \
-H "Accept: application/json" \
"https://localhost:8080/api/v1/organizations"
- lang: 'Python'
source: |
import requests
bearer_token = "..."
response = requests.get(
f"https://localhost:8080/api/v1/organizations",
headers={
"Authorization": f"Bearer {bearer_token}",
"Accept": "application/json"
}
)
orgs = response.json()
post:
tags:
- Organization
operationId: servertck.create_org
summary: Create an organization
responses:
'401':
description: Unauthenticated
'409':
description: Name already used globally
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'201':
description: The newly created organization
content:
application/json:
schema:
$ref: '#/components/schemas/Organization'
requestBody:
description: Organization definition
content:
application/json:
schema:
$ref: '#/components/schemas/NewOrganization'
x-code-samples:
- lang: 'cURL'
source: |
curl -H "Authorization: Bearer TOKEN" \
-H "Accept: application/json" \
"https://localhost:8080/api/v1/organizations/ORG_UUID"
- lang: 'Python'
source: |
import requests
bearer_token = "..."
org_uuid = ""
response = requests.get(
f"https://localhost:8080/api/v1/organizations/{org_uuid}",
headers={
"Authorization": f"Bearer {bearer_token}",
"Accept": "application/json"
}
)
org = response.json()
/organizations/{org_id}:
get:
tags:
- Organization
operationId: servertck.get_org
summary: Get an organization's details
parameters:
- $ref: '#/components/parameters/OrganizationId'
responses:
'401':
description: Unauthenticated
'404':
description: Organization not found
'200':
description: The organization
content:
application/json:
schema:
$ref: '#/components/schemas/Organization'
x-code-samples:
- lang: 'cURL'
source: |
curl -H "Authorization: Bearer TOKEN" \
-H "Accept: application/json" \
"https://localhost:8080/api/v1/organizations/ORG_UUID"
- lang: 'Python'
source: |
import requests
bearer_token = "..."
org_uuid = ""
response = requests.get(
f"https://localhost:8080/api/v1/organizations/{org_uuid}",
headers={
"Authorization": f"Bearer {bearer_token}",
"Accept": "application/json"
}
)
org = response.json()
delete:
tags:
- Organization
operationId: servertck.delete_org
summary: Delete an organization, the user must be its owner
parameters:
- $ref: '#/components/parameters/OrganizationId'
responses:
'401':
description: Unauthenticated
'404':
description: Organization not found
'204':
description: The organization is now deleted
x-code-samples:
- lang: 'cURL'
source: |
curl -XDELETE -H "Authorization: Bearer TOKEN" \
-H "Accept: application/json" \
"https://localhost:8080/api/v1/organizations/ORG_UUID"
- lang: 'Python'
source: |
import requests
bearer_token = "..."
org_uuid = ""
response = requests.delete(
f"https://localhost:8080/api/v1/organizations/{org_uuid}",
headers={
"Authorization": f"Bearer {bearer_token}",
"Accept": "application/json"
}
)
/organizations/{org_id}/workspaces:
get:
tags:
- Organization
operationId: servertck.get_org_workspaces
summary: Get all the workspaces of the given organization
parameters:
- $ref: '#/components/parameters/OrganizationId'
responses:
'401':
description: Unauthenticated
'404':
description: Organization not found
'200':
description: The organization's workspaces
content:
application/json:
schema:
$ref: '#/components/schemas/Workspaces'
/organizations/{org_id}/workspaces/{workspace_id}:
put:
tags:
- Organization
operationId: servertck.link_workspace_to_org
summary: Link a workspace to the given organization
parameters:
- $ref: '#/components/parameters/OrganizationId'
- $ref: '#/components/parameters/WorkspaceId'
responses:
'401':
description: Unauthenticated
'404':
description: Organization or workspace not found
'200':
description: The organization's workspaces
content:
application/json:
schema:
$ref: '#/components/schemas/Workspaces'
delete:
tags:
- Organization
operationId: servertck.unlink_workspace_from_org
summary: Unlink a workspace from the given organization
parameters:
- $ref: '#/components/parameters/OrganizationId'
- $ref: '#/components/parameters/WorkspaceId'
responses:
'401':
description: Unauthenticated
'404':
description: Organization or workspace not found
'204':
description: The workspace does not belong to this organization anymore
/workspaces:
get:
tags:
- Workspace
operationId: servertck.list_workspaces
summary: List all workspaces the authenticated user has access to
responses:
'401':
description: Unauthenticated
'200':
description: A list of workspaces
content:
application/json:
schema:
$ref: '#/components/schemas/Workspaces'
post:
tags:
- Workspace
operationId: servertck.create_workspace
summary: Create a workspace
responses:
'401':
description: Unauthenticated
'422':
description: Error in the payload
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: Name already used in this organization
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'201':
description: The newly created workspace
content:
application/json:
schema:
$ref: '#/components/schemas/Workspace'
requestBody:
description: Workspace definition
content:
application/json:
schema:
$ref: '#/components/schemas/NewWorkspace'
/workspaces/{workspace_id}:
get:
tags:
- Workspace
operationId: servertck.get_workspace
summary: Get a workspace's details
parameters:
- $ref: '#/components/parameters/WorkspaceId'
responses:
'401':
description: Unauthenticated
'404':
description: Workspace not found
'200':
description: The workspace
content:
application/json:
schema:
$ref: '#/components/schemas/Workspace'
delete:
tags:
- Workspace
operationId: servertck.delete_workspace
summary: Delete a workspace, the user must be its owner
parameters:
- $ref: '#/components/parameters/WorkspaceId'
responses:
'401':
description: Unauthenticated
'404':
description: Workspace not found
'204':
description: The workspace is now deleted
/workspaces/{workspace_id}/experiments:
get:
tags:
- Workspace
operationId: servertck.get_workspace_experiments
summary: Get a workspace's experiments
parameters:
- $ref: '#/components/parameters/WorkspaceId'
responses:
'401':
description: Unauthenticated
'404':
description: Workspace not found
'200':
description: The experiments
content:
application/json:
schema:
$ref: '#/components/schemas/Experiments'
/experiments:
post:
tags:
- Experiment
operationId: servertck.upload_experiment
summary: Create an experiment
responses:
'401':
description: Unauthenticated
'422':
description: Error in the payload
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'201':
description: The newly created experiment
content:
application/json:
schema:
$ref: '#/components/schemas/Experiment'
requestBody:
description: Experiment definition
content:
application/json:
schema:
$ref: '#/components/schemas/NewExperiment'
/experiments/{experiment_id}:
get:
tags:
- Experiment
operationId: servertck.get_experiment
summary: Get an experiment's details
parameters:
- $ref: '#/components/parameters/ExperimentId'
responses:
'401':
description: Unauthenticated
'404':
description: Experiment not found
'200':
description: The experiment
content:
application/json:
schema:
$ref: '#/components/schemas/Experiment'
delete:
tags:
- Experiment
operationId: servertck.delete_experiment
summary: Delete an experiment, the user must be its owner
parameters:
- $ref: '#/components/parameters/ExperimentId'
responses:
'401':
description: Unauthenticated
'404':
description: Experiment not found
'204':
description: The experiment is now deleted
/experiments/{experiment_id}/executions:
get:
tags:
- Experiment
operationId: servertck.get_experiment_executions
summary: Get the experiment's executions
parameters:
- $ref: '#/components/parameters/ExperimentId'
responses:
'401':
description: Unauthenticated
'404':
description: Experiment not found
'200':
description: The executions
content:
application/json:
schema:
$ref: '#/components/schemas/Executions'
/experiments/{experiment_id}/schedulings:
get:
tags:
- Experiment
operationId: servertck.get_experiment_schedulings
summary: Get all the experiment's schedulings
parameters:
- $ref: '#/components/parameters/ExperimentId'
responses:
'401':
description: Unauthenticated
'404':
description: Experiment not found
'200':
description: The experiment schedulings
content:
application/json:
schema:
$ref: '#/components/schemas/Schedulings'
/experiments/{experiment_id}/policy:
get:
tags:
- Experiment
operationId: servertck.get_experiment_policy
summary: Get the experiment's policy
parameters:
- $ref: '#/components/parameters/ExperimentId'
responses:
'401':
description: Unauthenticated
'404':
description: Experiment not found
'200':
description: The experiment policy
content:
application/json:
schema:
$ref: '#/components/schemas/Policy'
post:
tags:
- Experiment
operationId: servertck.set_experiment_policy
summary: Set a policy onto an experiment
parameters:
- $ref: '#/components/parameters/ExperimentId'
responses:
'401':
description: Unauthenticated
'404':
description: Experiment not found
'200':
description: The experiment policy is set
requestBody:
description: Policy
content:
application/json:
schema:
$ref: '#/components/schemas/Policy'
/executions:
post:
tags:
- Execution
operationId: servertck.upload_execution
summary: Upload an execution
responses:
'401':
description: Unauthenticated
'422':
description: Error in the payload
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'201':
description: The newly created execution
content:
application/json:
schema:
$ref: '#/components/schemas/Execution'
requestBody:
description: Execution definition
content:
application/json:
schema:
$ref: '#/components/schemas/NewExecution'
/executions/{execution_id}:
get:
tags:
- Execution
operationId: servertck.get_execution
summary: Get an execution's details
parameters:
- $ref: '#/components/parameters/ExecutionId'
responses:
'401':
description: Unauthenticated
'404':
description: Execution not found
'200':
description: The execution
content:
application/json:
schema:
$ref: '#/components/schemas/Execution'
delete:
tags:
- Execution
operationId: servertck.delete_execution
summary: Delete an execution, the user must be its owner
parameters:
- $ref: '#/components/parameters/ExecutionId'
responses:
'401':
description: Unauthenticated
'404':
description: Execution not found
'204':
description: The execution is now deleted
/executions/{execution_id}/journal:
get:
tags:
- Execution
operationId: servertck.get_execution_journal
summary: Get an execution's journal
parameters:
- $ref: '#/components/parameters/ExecutionId'
responses:
'401':
description: Unauthenticated
'404':
description: Execution not found
'200':
description: The execution's journal
content:
application/json:
schema:
$ref: '#/components/schemas/Journal'
/executions/{execution_id}/report:
get:
tags:
- Execution
operationId: servertck.get_execution_report
summary: Get an execution's report (as PDF, HTML...)
parameters:
- $ref: '#/components/parameters/ExecutionId'
responses:
'401':
description: Unauthenticated
'404':
description: Execution not found
'200':
description: The execution's report
content:
application/pdf:
schema:
type: string
format: binary
text/html:
schema:
type: string
/scheduling:
get:
tags:
- Scheduling
operationId: servertck.get_schedulings
summary: Get schedulings the authenticated user owns
responses:
'401':
description: Unauthenticated
'200':
description: The schedulings
content:
application/json:
schema:
$ref: '#/components/schemas/Scheduling'
post:
tags:
- Scheduling
operationId: servertck.create_scheduling
summary: Create a scheduling
responses:
'401':
description: Unauthenticated
'201':
description: The newly created scheduling
content:
application/json:
schema:
$ref: '#/components/schemas/Scheduling'
requestBody:
description: Scheduling definition
content:
application/json:
schema:
$ref: '#/components/schemas/NewScheduling'
/scheduling/{scheduling_id}:
get:
tags:
- Scheduling
operationId: servertck.get_scheduling
summary: Get schedulings the authenticated user owns
parameters:
- $ref: '#/components/parameters/SchedulingId'
responses:
'401':
description: Unauthenticated
'200':
description: The scheduling
content:
application/json:
schema:
$ref: '#/components/schemas/Scheduling'
delete:
tags:
- Scheduling
operationId: servertck.delete_scheduling
summary: Delete a scheduling the authenticated user owns
parameters:
- $ref: '#/components/parameters/SchedulingId'
responses:
'401':
description: Unauthenticated
'204':
description: The scheduling is deleted
/scheduling/{scheduling_id}/status:
get:
tags:
- Scheduling
operationId: servertck.get_scheduling_status
summary: Get the status of the scheduling
parameters:
- $ref: '#/components/parameters/SchedulingId'
responses:
'401':
description: Unauthenticated
'200':
description: The scheduling's status
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulingStatus'
post:
tags:
- Scheduling
operationId: servertck.set_scheduling_status
summary: Set the status of the scheduling
parameters:
- $ref: '#/components/parameters/SchedulingId'
responses:
'401':
description: Unauthenticated
'200':
description: The scheduling status is set
requestBody:
description: Scheduling status definition
content:
application/json:
schema:
$ref: '#/components/schemas/NewSchedulingStatus'
/scheduling/{scheduling_id}/status/history:
get:
tags:
- Scheduling
operationId: servertck.get_scheduling_status_history
summary: Get the status history of the scheduling ordered by date
parameters:
- $ref: '#/components/parameters/SchedulingId'
responses:
'401':
description: Unauthenticated
'200':
description: The scheduling's status history
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulingStatusHistory'
/scheduling/{scheduling_id}/executions:
get:
tags:
- Scheduling
operationId: servertck.get_scheduling_executions
summary: Get the executions, past and planned, for this scheduling
parameters:
- $ref: '#/components/parameters/SchedulingId'
responses:
'401':
description: Unauthenticated
'200':
description: The scheduling's executions
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulingExecutions'
/policies:
get:
tags:
- Policy
operationId: servertck.get_policies
summary: Get all policies
responses:
'401':
description: Unauthenticated
'200':
description: The policies
content:
application/json:
schema:
$ref: '#/components/schemas/Policies'
post:
tags:
- Policy
operationId: servertck.create_policy
summary: Create a policy
responses:
'401':
description: Unauthenticated
'201':
description: The newly created Pplicy
content:
application/json:
schema:
$ref: '#/components/schemas/Policy'
requestBody:
description: Policy definition
content:
application/json:
schema:
$ref: '#/components/schemas/NewPolicy'
/policies/{policy_id}:
get:
tags:
- Policy
operationId: servertck.get_policy
summary: Get a scheduling policy
parameters:
- $ref: '#/components/parameters/PolicyId'
responses:
'401':
description: Unauthenticated