-
Notifications
You must be signed in to change notification settings - Fork 341
Expand file tree
/
Copy pathswagger.yaml
More file actions
3517 lines (3517 loc) · 92.8 KB
/
swagger.yaml
File metadata and controls
3517 lines (3517 loc) · 92.8 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
basePath: /
definitions:
AdminLoginResponse:
properties:
idToken:
type: string
type: object
ArgoCDShard:
properties:
namespace:
type: string
url:
type: string
type: object
Claim:
properties:
name:
type: string
values:
items:
type: string
type: array
type: object
CreateAPITokenRequest:
properties:
name:
type: string
type: object
CreateConfigMapRequest:
properties:
data:
additionalProperties:
type: string
type: object
description:
type: string
name:
type: string
type: object
CreateGenericCredentialsRequest:
properties:
data:
additionalProperties:
type: string
type: object
description:
type: string
name:
type: string
type: object
CreateOrUpdateResourceResponse:
properties:
results:
items:
$ref: '#/definitions/CreateOrUpdateResourceResult'
type: array
type: object
CreateOrUpdateResourceResult:
properties:
createdResourceManifest:
additionalProperties: {}
type: object
error:
type: string
updatedResourceManifest:
additionalProperties: {}
type: object
type: object
CreateRepoCredentialsRequest:
properties:
description:
type: string
name:
type: string
password:
description: |-
#nosec G117 -- Request data is unmarshaled into this struct, but the struct
is never marshaled and transmitted to anywhere.
type: string
repoUrl:
type: string
repoUrlIsRegex:
type: boolean
type:
type: string
username:
type: string
type: object
CreateResourceResponse:
properties:
results:
items:
$ref: '#/definitions/CreateResourceResult'
type: array
type: object
CreateResourceResult:
properties:
createdResourceManifest:
additionalProperties: {}
type: object
error:
type: string
type: object
DeleteResourceResponse:
properties:
results:
items:
$ref: '#/definitions/DeleteResourceResult'
type: array
type: object
DeleteResourceResult:
properties:
deletedResourceManifest:
additionalProperties: {}
type: object
error:
type: string
type: object
GetConfigResponse:
properties:
argocdShards:
additionalProperties:
$ref: '#/definitions/ArgoCDShard'
type: object
hasAnalysisRunLogsUrlTemplate:
type: boolean
kargoNamespace:
type: string
secretManagementEnabled:
type: boolean
sharedResourcesNamespace:
type: string
systemResourcesNamespace:
type: string
type: object
GrantRequest:
properties:
resourceDetails:
$ref: '#/definitions/ResourceDetails'
role:
type: string
userClaims:
$ref: '#/definitions/UserClaims'
type: object
ImageStageMap:
properties:
stages:
additionalProperties:
format: int32
type: integer
type: object
type: object
OIDCConfig:
properties:
cliClientId:
type: string
clientId:
type: string
issuerUrl:
type: string
scopes:
items:
type: string
type: array
type: object
PatchConfigMapRequest:
properties:
data:
additionalProperties:
type: string
type: object
description:
type: string
removeKeys:
items:
type: string
type: array
type: object
PatchGenericCredentialsRequest:
properties:
data:
additionalProperties:
type: string
type: object
description:
type: string
removeKeys:
items:
type: string
type: array
type: object
PatchRepoCredentialsRequest:
properties:
description:
type: string
password:
description: |-
#nosec G117 -- Request data is unmarshaled into this struct, but the struct
is never marshaled and transmitted to anywhere.
type: string
repoUrl:
type: string
repoUrlIsRegex:
type: boolean
type:
type: string
username:
type: string
type: object
PromoteDownstreamRequest:
properties:
freight:
type: string
freightAlias:
type: string
type: object
PromoteToStageRequest:
properties:
freight:
type: string
freightAlias:
type: string
type: object
PublicConfig:
properties:
adminAccountEnabled:
type: boolean
oidcConfig:
$ref: '#/definitions/OIDCConfig'
skipAuth:
type: boolean
type: object
ResourceDetails:
properties:
resourceName:
type: string
resourceType:
type: string
verbs:
items:
type: string
type: array
type: object
RevokeRequest:
properties:
resourceDetails:
$ref: '#/definitions/ResourceDetails'
role:
type: string
userClaims:
$ref: '#/definitions/UserClaims'
type: object
TagMap:
properties:
tags:
additionalProperties:
$ref: '#/definitions/ImageStageMap'
type: object
type: object
UpdateConfigMapRequest:
properties:
data:
additionalProperties:
type: string
type: object
description:
type: string
type: object
UpdateGenericCredentialsRequest:
properties:
data:
additionalProperties:
type: string
type: object
description:
type: string
type: object
UpdateRepoCredentialsRequest:
properties:
description:
type: string
password:
description: |-
#nosec G117 -- Request data is unmarshaled into this struct, but the struct
is never marshaled and transmitted to anywhere.
type: string
repoUrl:
type: string
repoUrlIsRegex:
type: boolean
type:
type: string
username:
type: string
type: object
UserClaims:
properties:
claims:
items:
$ref: '#/definitions/Claim'
type: array
type: object
VersionInfo:
properties:
buildDate:
description: BuildDate is the date/time on which the application was built.
type: string
compiler:
description: Compiler indicates what Go compiler was used for the build.
type: string
gitCommit:
description: |-
GitCommit is the ID (sha) of the last commit to the application's source
code that is included in this build.
type: string
gitTreeDirty:
description: |-
GitTreeDirty is true if the application's source code contained
uncommitted changes at the time it was built; otherwise it is false.
type: boolean
goVersion:
description: GoVersion is the version of Go that was used to build the application.
type: string
platform:
description: |-
Platform indicates the OS and CPU architecture for which the application
was built.
type: string
version:
description: Version is a human-friendly version string.
type: string
type: object
info:
contact: {}
description: REST API for Kargo
title: Kargo API
version: v1alpha1
paths:
/v1beta1/login:
post:
description: Authenticate as the admin user if enabled.
operationId: AdminLogin
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/AdminLoginResponse'
security:
- BearerAuth: []
summary: Admin login
tags:
- System
/v1beta1/projects:
get:
description: List all Projects resources. Returns a ProjectList resource.
operationId: ListProjects
produces:
- application/json
responses:
"200":
description: ProjectList custom resource (github.com/akuity/kargo/api/v1alpha1.ProjectList)
schema:
type: object
security:
- BearerAuth: []
summary: List projects
tags:
- Core
- Cluster-Scoped Resource
/v1beta1/projects/{project}:
delete:
description: Delete a Project resource and its associated namespace.
operationId: DeleteProject
parameters:
- description: Project name
in: path
name: project
required: true
type: string
responses:
"204":
description: Deleted successfully
security:
- BearerAuth: []
summary: Delete a Project
tags:
- Core
- Cluster-Scoped Resource
get:
description: Retrieve a Project resource.
operationId: GetProject
parameters:
- description: Project name
in: path
name: project
required: true
type: string
produces:
- application/json
responses:
"200":
description: Project custom resource (github.com/akuity/kargo/api/v1alpha1.Project)
schema:
type: object
security:
- BearerAuth: []
summary: Retrieve a Project resource
tags:
- Core
- Cluster-Scoped Resource
/v1beta1/projects/{project}/analysis-runs/{analysis-run}:
get:
description: Retrieve an AnalysisRun resource from a project's namespace.
operationId: GetAnalysisRun
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: AnalysisRun name
in: path
name: analysis-run
required: true
type: string
produces:
- application/json
responses:
"200":
description: AnalysisRun custom resource (github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1.AnalysisRun)
schema:
type: object
security:
- BearerAuth: []
summary: Retrieve an AnalysisRun
tags:
- Verifications
- Project-Level
/v1beta1/projects/{project}/analysis-runs/{analysis-run}/logs:
get:
description: Stream logs from an AnalysisRun job as Server-Sent Events (SSE).
operationId: GetAnalysisRunLogs
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: AnalysisRun name
in: path
name: analysis-run
required: true
type: string
- description: Metric name
in: query
name: metricName
type: string
- description: Container name
in: query
name: containerName
type: string
produces:
- text/event-stream
responses:
"200":
description: Log stream (SSE)
schema:
type: string
security:
- BearerAuth: []
summary: Stream AnalysisRun logs
tags:
- Verifications
- Project-Level
/v1beta1/projects/{project}/analysis-templates:
get:
description: List AnalysisTemplate resources from a project's namespace.
operationId: ListAnalysisTemplates
parameters:
- description: Project name
in: path
name: project
required: true
type: string
produces:
- application/json
responses:
"200":
description: AnalysisTemplateList custom resource (github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1.AnalysisTemplateList)
schema:
type: object
security:
- BearerAuth: []
summary: List AnalysisTemplates
tags:
- Verifications
- Project-Level
/v1beta1/projects/{project}/analysis-templates/{analysis-template}:
delete:
description: Delete an AnalysisTemplate resource from a project's namespace.
operationId: DeleteAnalysisTemplate
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: AnalysisTemplate name
in: path
name: analysis-template
required: true
type: string
responses:
"204":
description: Deleted successfully
security:
- BearerAuth: []
summary: Delete an AnalysisTemplate
tags:
- Verifications
- Project-Level
get:
description: |-
Retrieve an AnalysisTemplate resource from a project's
namespace.
operationId: GetAnalysisTemplate
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: AnalysisTemplate name
in: path
name: analysis-template
required: true
type: string
produces:
- application/json
responses:
"200":
description: AnalysisTemplate custom resource (github.com/argoproj/argo-rollouts/pkg/apis/rollouts/v1alpha1.AnalysisTemplate)
schema:
type: object
security:
- BearerAuth: []
summary: Retrieve an AnalysisTemplate
tags:
- Verifications
- Project-Level
/v1beta1/projects/{project}/api-tokens:
get:
description: |-
List project-level API tokens. Returns a Kubernetes SecretList
resource containing heavily redacted Secrets.
operationId: ListProjectAPITokens
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: Role name filter
in: query
name: role
type: string
produces:
- application/json
responses:
"200":
description: SecretList resource (k8s.io/api/core/v1.SecretList)
schema:
type: object
security:
- BearerAuth: []
summary: List project-level API tokens
tags:
- Rbac
- Credentials
- Project-Level
/v1beta1/projects/{project}/api-tokens/{apitoken}:
delete:
description: Delete a project-level API token from a project's namespace.
operationId: DeleteProjectAPIToken
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: API token name
in: path
name: apitoken
required: true
type: string
responses:
"204":
description: Deleted successfully
security:
- BearerAuth: []
summary: Delete a project-level API token
tags:
- Rbac
- Credentials
- Project-Level
get:
description: |-
Retrieve a project-level API token by name. Returns a heavily
redacted Kubernetes Secret resource.
operationId: GetProjectAPIToken
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: API token name
in: path
name: apitoken
required: true
type: string
produces:
- application/json
responses:
"200":
description: Secret resource (k8s.io/api/core/v1.Secret)
schema:
type: object
security:
- BearerAuth: []
summary: Retrieve a project-level API token
tags:
- Rbac
- Credentials
- Project-Level
/v1beta1/projects/{project}/config:
delete:
description: |-
Delete the single ProjectConfig resource from a project's
namespace.
operationId: DeleteProjectConfig
parameters:
- description: Project name
in: path
name: project
required: true
type: string
responses:
"204":
description: Deleted successfully
security:
- BearerAuth: []
summary: Delete a ProjectConfig resource
tags:
- Core
- Project-Level
- Config
- Singleton
get:
description: |-
Retrieve the single ProjectConfig resource from a project's
namespace.
operationId: GetProjectConfig
parameters:
- description: Project name
in: path
name: project
required: true
type: string
produces:
- application/json
responses:
"200":
description: ProjectConfig custom resource (github.com/akuity/kargo/api/v1alpha1.ProjectConfig)
schema:
type: object
security:
- BearerAuth: []
summary: Retrieve ProjectConfig
tags:
- Core
- Project-Level
- Config
- Singleton
/v1beta1/projects/{project}/config/refresh:
post:
description: |-
Refresh the single ProjectConfig resource in a project's
namespace. Refreshing enqueues the resource for reconciliation
by its corresponding controller.
operationId: RefreshProjectConfig
parameters:
- description: Project name
in: path
name: project
required: true
type: string
produces:
- application/json
responses:
"200":
description: Success
security:
- BearerAuth: []
summary: Refresh ProjectConfig
tags:
- Core
- Config
- Project-Level
- Singleton
/v1beta1/projects/{project}/configmaps:
get:
description: |-
List ConfigMap resources from a project's namespace. Returns a
Kubernetes ConfigMapList resource.
operationId: ListProjectConfigMaps
parameters:
- description: Project name
in: path
name: project
required: true
type: string
produces:
- application/json
responses:
"200":
description: ConfigMapList resource (k8s.io/api/core/v1.ConfigMapList)
schema:
type: object
security:
- BearerAuth: []
summary: List project-level ConfigMaps
tags:
- Core
- Generic Config
- Project-Level
post:
consumes:
- application/json
description: |-
Create a ConfigMap in a project's namespace. Returns the created
Kubernetes ConfigMap resource.
operationId: CreateProjectConfigMap
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: ConfigMap
in: body
name: body
required: true
schema:
$ref: '#/definitions/CreateConfigMapRequest'
produces:
- application/json
responses:
"201":
description: ConfigMap resource (k8s.io/api/core/v1.ConfigMap)
schema:
type: object
security:
- BearerAuth: []
summary: Create a project-level ConfigMap
tags:
- Core
- Generic Config
- Project-Level
/v1beta1/projects/{project}/configmaps/{configmap}:
delete:
description: Delete a ConfigMap from a project's namespace.
operationId: DeleteProjectConfigMap
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: ConfigMap name
in: path
name: configmap
required: true
type: string
responses:
"204":
description: Deleted successfully
security:
- BearerAuth: []
summary: Delete a project-level ConfigMap
tags:
- Core
- Generic Config
- Project-Level
get:
description: Retrieve a ConfigMap by name from a project's namespace.
operationId: GetProjectConfigMap
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: ConfigMap name
in: path
name: configmap
required: true
type: string
produces:
- application/json
responses:
"200":
description: ConfigMap resource (k8s.io/api/core/v1.ConfigMap)
schema:
type: object
security:
- BearerAuth: []
summary: Retrieve a project-level ConfigMap
tags:
- Core
- Generic Config
- Project-Level
patch:
consumes:
- application/json
description: |-
Patch a ConfigMap in a project's namespace. Merges provided data
with existing data. Use removeKeys to delete specific keys.
Returns the updated Kubernetes ConfigMap resource.
operationId: PatchProjectConfigMap
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: ConfigMap name
in: path
name: configmap
required: true
type: string
- description: ConfigMap patch
in: body
name: body
required: true
schema:
$ref: '#/definitions/PatchConfigMapRequest'
produces:
- application/json
responses:
"200":
description: ConfigMap resource (k8s.io/api/core/v1.ConfigMap)
schema:
type: object
security:
- BearerAuth: []
summary: Patch a project-level ConfigMap
tags:
- Core
- Generic Config
- Project-Level
put:
consumes:
- application/json
description: |-
Replace a ConfigMap in a project's namespace. All existing data
is replaced. Returns the updated Kubernetes ConfigMap resource.
operationId: UpdateProjectConfigMap
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: ConfigMap name
in: path
name: configmap
required: true
type: string
- description: ConfigMap
in: body
name: body
required: true
schema:
$ref: '#/definitions/UpdateConfigMapRequest'
produces:
- application/json
responses:
"200":
description: ConfigMap resource (k8s.io/api/core/v1.ConfigMap)
schema:
type: object
security:
- BearerAuth: []
summary: Replace a project-level ConfigMap
tags:
- Core
- Generic Config
- Project-Level
/v1beta1/projects/{project}/events:
get:
description: |-
List Kubernetes Events from a project's namespace. Returns a
Kubernetes EventList resource.
operationId: ListProjectEvents
parameters:
- description: Project name
in: path
name: project
required: true
type: string
produces:
- application/json
responses:
"200":
description: EventList resource (k8s.io/api/core/v1.EventList)
schema:
type: object
security:
- BearerAuth: []
summary: List project-level Kubernetes Events
tags:
- Events
- Project-Level
/v1beta1/projects/{project}/freight:
get:
description: Query and filter Freight resources from a project's namespace.
operationId: QueryFreightsRest
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: Stage name to get available freight for
in: query
name: stage
type: string
- collectionFormat: csv
description: Warehouse names to get freight from
in: query
items:
type: string
name: origins
type: array
- description: Group filter
in: query
name: group
type: string
- description: Group by (image_repo, git_repo, chart_repo)
in: query
name: groupBy
type: string
- description: Order by (first_seen, tag)
in: query
name: orderBy
type: string
- description: Reverse order
in: query
name: reverse
type: boolean
produces:
- application/json
responses:
"200":
description: Map of freight groups
schema:
type: object
security:
- BearerAuth: []
summary: Query Freight
tags:
- Core
- Project-Level
/v1beta1/projects/{project}/freight/{freight-name-or-alias}:
delete:
description: |-
Delete a Freight resource from a project's namespace by name or
alias.
operationId: DeleteFreight
parameters:
- description: Project name
in: path
name: project
required: true
type: string
- description: Freight name or alias
in: path
name: freight-name-or-alias
required: true
type: string
responses:
"204":
description: Deleted successfully
security:
- BearerAuth: []
summary: Delete a Freight resource
tags: