-
Notifications
You must be signed in to change notification settings - Fork 6
/
harbor_swagger_openapi3.yaml
7148 lines (7141 loc) · 216 KB
/
harbor_swagger_openapi3.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:
title: Harbor API
description: These APIs provide services for manipulating Harbor project.
version: 2.0
security:
- basic: []
- {}
paths:
/search:
get:
summary: 'Search for projects, repositories and helm charts'
description: >-
The Search endpoint returns information about the projects, repositories
and helm charts offered at public status or related to the current
logged in user. The response includes the project, repository list and
charts in a proper display order.
parameters:
- name: q
in: query
description: Search parameter for project and repository name.
required: true
schema:
type: string
tags:
- search
operationId: search
responses:
'200':
description: An array of search results
content:
application/json:
schema:
$ref: '#/components/schemas/Search'
'500':
$ref: '#/components/responses/500'
/ldap/ping:
post:
operationId: pingLdap
summary: Ping available ldap service.
description: >
This endpoint ping the available ldap service for test related
configuration parameters.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LdapConf'
description: >-
ldap configuration. support input ldap service configuration. If it is
a empty request, will load current configuration from the system.
tags:
- Ldap
responses:
'200':
description: Ping ldap service successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/LdapPingResult'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'500':
$ref: '#/components/responses/500'
/ldap/users/search:
get:
operationId: searchLdapUser
summary: Search available ldap users.
description: >
This endpoint searches the available ldap users based on related
configuration parameters. Support searched by input ladp configuration,
load configuration from the system and specific filter.
parameters:
- name: username
in: query
required: false
description: Registered user ID
schema:
type: string
tags:
- Ldap
responses:
'200':
description: Search ldap users successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LdapUser'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'500':
$ref: '#/components/responses/500'
/ldap/users/import:
post:
operationId: importLdapUser
summary: Import selected available ldap users.
description: >
This endpoint adds the selected available ldap users to harbor based on
related configuration parameters from the system. System will try to
guess the user email address and realname, add to harbor user
information. If have errors when import user, will return the list of
importing failed uid and the failed reason.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LdapImportUsers'
description: >-
The uid listed for importing. This list will check users validity of
ldap service based on configuration from the system.
required: true
tags:
- Ldap
responses:
'200':
description: Add ldap users successfully.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
description: Failed import some users.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LdapFailedImportUser'
'500':
$ref: '#/components/responses/500'
/ldap/groups/search:
get:
summary: Search available ldap groups.
operationId: searchLdapGroup
description: >
This endpoint searches the available ldap groups based on related
configuration parameters. support to search by groupname or groupdn.
parameters:
- name: groupname
in: query
required: false
description: Ldap group name
schema:
type: string
- name: groupdn
in: query
required: false
description: The LDAP group DN
schema:
type: string
tags:
- Ldap
responses:
'200':
description: Search ldap group successfully.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UserGroup'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'500':
$ref: '#/components/responses/500'
/projects:
get:
summary: List projects
description: This endpoint returns projects created by Harbor.
tags:
- project
operationId: listProjects
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/query'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/sort'
- name: name
in: query
description: The name of project.
required: false
schema:
type: string
- name: public
in: query
description: The project is public or private.
required: false
schema:
type: boolean
format: int32
- name: owner
in: query
description: The name of project owner.
required: false
schema:
type: string
- name: with_detail
in: query
description: >-
Bool value indicating whether return detailed information of the
project
required: false
schema:
type: boolean
default: true
responses:
'200':
description: Return all matched projects.
headers:
X-Total-Count:
description: The total count of projects
schema:
type: integer
Link:
description: Link refers to the previous page and next page
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Project'
'401':
$ref: '#/components/responses/401'
'500':
$ref: '#/components/responses/500'
head:
summary: Check if the project name user provided already exists.
description: >-
This endpoint is used to check if the project name provided already
exist.
tags:
- project
operationId: headProject
parameters:
- $ref: '#/components/parameters/requestId'
- name: project_name
in: query
description: Project name for checking exists.
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/200'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
post:
summary: Create a new project.
description: This endpoint is for user to create a new project.
tags:
- project
operationId: createProject
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/resourceNameInLocation'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectReq'
description: New created project.
required: true
responses:
'201':
$ref: '#/components/responses/201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
'/projects/{project_name_or_id}':
get:
summary: Return specific project detail information
description: This endpoint returns specific project information by project ID.
tags:
- project
operationId: getProject
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/isResourceName'
- $ref: '#/components/parameters/projectNameOrId'
responses:
'200':
description: Return matched project information.
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'401':
$ref: '#/components/responses/401'
'500':
$ref: '#/components/responses/500'
put:
summary: Update properties for a selected project.
description: This endpoint is aimed to update the properties of a project.
tags:
- project
operationId: updateProject
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/isResourceName'
- $ref: '#/components/parameters/projectNameOrId'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectReq'
description: Updates of project.
required: true
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
delete:
summary: Delete project by projectID
description: This endpoint is aimed to delete project by project ID.
tags:
- project
operationId: deleteProject
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/isResourceName'
- $ref: '#/components/parameters/projectNameOrId'
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'412':
$ref: '#/components/responses/412'
'500':
$ref: '#/components/responses/500'
'/projects/{project_name_or_id}/_deletable':
get:
summary: Get the deletable status of the project
description: Get the deletable status of the project
tags:
- project
operationId: getProjectDeletable
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/isResourceName'
- $ref: '#/components/parameters/projectNameOrId'
responses:
'200':
description: Return deletable status of the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectDeletable'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'/projects/{project_name_or_id}/summary':
get:
summary: Get summary of the project.
description: Get summary of the project.
tags:
- project
operationId: getProjectSummary
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/isResourceName'
- $ref: '#/components/parameters/projectNameOrId'
responses:
'200':
description: Get summary of the project successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectSummary'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'/projects/{project_name}/repositories':
get:
summary: List repositories
description: List repositories of the specified project
tags:
- repository
operationId: listRepositories
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/query'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/pageSize'
responses:
'200':
description: Success
headers:
X-Total-Count:
description: The total count of repositories
schema:
type: integer
Link:
description: Link refers to the previous page and next page
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Repository'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'/projects/{project_name}/repositories/{repository_name}':
get:
summary: Get repository
description: Get the repository specified by name
tags:
- repository
operationId: getRepository
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Repository'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
put:
summary: Update repository
description: Update the repository specified by name
tags:
- repository
operationId: updateRepository
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Repository'
description: The JSON object of repository.
required: true
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
delete:
summary: Delete repository
description: Delete the repository specified by name
tags:
- repository
operationId: deleteRepository
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'/projects/{project_name}/repositories/{repository_name}/artifacts':
get:
summary: List artifacts
description: >-
List artifacts under the specific project and repository. Except the
basic properties, the other supported queries in "q" includes "tags=*"
to list only tagged artifacts, "tags=nil" to list only untagged
artifacts, "tags=~v" to list artifacts whose tag fuzzy matches "v",
"tags=v" to list artifact whose tag exactly matches "v", "labels=(id1,
id2)" to list artifacts that both labels with id1 and id2 are added to
tags:
- artifact
operationId: listArtifacts
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'
- $ref: '#/components/parameters/query'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/acceptVulnerabilities'
- name: with_tag
in: query
description: Specify whether the tags are included inside the returning artifacts
required: false
schema:
type: boolean
default: true
- name: with_label
in: query
description: >-
Specify whether the labels are included inside the returning
artifacts
required: false
schema:
type: boolean
default: false
- name: with_scan_overview
in: query
description: >-
Specify whether the scan overview is included inside the returning
artifacts
required: false
schema:
type: boolean
default: false
- name: with_signature
in: query
description: >-
Specify whether the signature is included inside the tags of the
returning artifacts. Only works when setting "with_tag=true"
required: false
schema:
type: boolean
default: false
- name: with_immutable_status
in: query
description: >-
Specify whether the immutable status is included inside the tags of
the returning artifacts. Only works when setting "with_tag=true"
required: false
schema:
type: boolean
default: false
responses:
'200':
description: Success
headers:
X-Total-Count:
description: The total count of artifacts
schema:
type: integer
Link:
description: Link refers to the previous page and next page
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Artifact'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
post:
summary: Copy artifact
description: Copy the artifact specified in the "from" parameter to the repository.
tags:
- artifact
operationId: CopyArtifact
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'
- name: from
in: query
description: >-
The artifact from which the new artifact is copied from, the format
should be "project/repository:tag" or "project/repository@digest".
required: true
schema:
type: string
responses:
'201':
$ref: '#/components/responses/201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'500':
$ref: '#/components/responses/500'
'/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}':
get:
summary: Get the specific artifact
description: >-
Get the artifact specified by the reference under the project and
repository. The reference can be digest or tag.
tags:
- artifact
operationId: getArtifact
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'
- $ref: '#/components/parameters/reference'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/acceptVulnerabilities'
- name: with_tag
in: query
description: Specify whether the tags are inclued inside the returning artifacts
required: false
schema:
type: boolean
default: true
- name: with_label
in: query
description: >-
Specify whether the labels are inclued inside the returning
artifacts
required: false
schema:
type: boolean
default: false
- name: with_scan_overview
in: query
description: >-
Specify whether the scan overview is inclued inside the returning
artifacts
required: false
schema:
type: boolean
default: false
- name: with_signature
in: query
description: >-
Specify whether the signature is inclued inside the returning
artifacts
required: false
schema:
type: boolean
default: false
- name: with_immutable_status
in: query
description: >-
Specify whether the immutable status is inclued inside the tags of
the returning artifacts. Only works when setting "with_tag=true"
required: false
schema:
type: boolean
default: false
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Artifact'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
delete:
summary: Delete the specific artifact
description: >-
Delete the artifact specified by the reference under the project and
repository. The reference can be digest or tag
tags:
- artifact
operationId: deleteArtifact
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'
- $ref: '#/components/parameters/reference'
responses:
'200':
$ref: '#/components/responses/200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan':
post:
summary: Scan the artifact
description: Scan the specified artifact
tags:
- scan
operationId: scanArtifact
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'
- $ref: '#/components/parameters/reference'
responses:
'202':
$ref: '#/components/responses/202'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/scan/{report_id}/log':
get:
summary: Get the log of the scan report
description: Get the log of the scan report
tags:
- scan
operationId: getReportLog
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'
- $ref: '#/components/parameters/reference'
- name: report_id
in: path
required: true
description: The report id to get the log
schema:
type: string
responses:
'200':
description: Successfully get scan log file
content:
text/plain:
schema:
type: string
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags':
post:
summary: Create tag
description: Create a tag for the specified artifact
tags:
- artifact
operationId: createTag
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'
- $ref: '#/components/parameters/reference'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: The JSON object of tag.
required: true
responses:
'201':
$ref: '#/components/responses/201'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
get:
summary: List tags
description: List tags of the specific artifact
tags:
- artifact
operationId: listTags
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'
- $ref: '#/components/parameters/reference'
- $ref: '#/components/parameters/query'
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/pageSize'
- name: with_signature
in: query
description: Specify whether the signature is included inside the returning tags
required: false
schema:
type: boolean
default: false
- name: with_immutable_status
in: query
description: >-
Specify whether the immutable status is included inside the
returning tags
required: false
schema:
type: boolean
default: false
responses:
'200':
description: Success
headers:
X-Total-Count:
description: The total count of tags
schema:
type: integer
Link:
description: Link refers to the previous page and next page
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Tag'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/tags/{tag_name}':
delete:
summary: Delete tag
description: Delete the tag of the specified artifact
tags:
- artifact
operationId: deleteTag
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'
- $ref: '#/components/parameters/reference'
- $ref: '#/components/parameters/tagName'
responses:
'200':
$ref: '#/components/responses/200'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/additions/vulnerabilities':
get:
summary: Get the vulnerabilities addition of the specific artifact
description: >-
Get the vulnerabilities addition of the artifact specified by the
reference under the project and repository.
tags:
- artifact
operationId: getVulnerabilitiesAddition
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'
- $ref: '#/components/parameters/reference'
- $ref: '#/components/parameters/acceptVulnerabilities'
responses:
'200':
description: Success
headers:
Content-Type:
description: The content type of the vulnerabilities addition
schema:
type: string
content:
application/json:
schema:
type: string
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
'/projects/{project_name}/repositories/{repository_name}/artifacts/{reference}/additions/{addition}':
get:
summary: Get the addition of the specific artifact
description: >-
Get the addition of the artifact specified by the reference under the
project and repository.
tags:
- artifact
operationId: getAddition
parameters:
- $ref: '#/components/parameters/requestId'
- $ref: '#/components/parameters/projectName'
- $ref: '#/components/parameters/repositoryName'