-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
5442 lines (5426 loc) · 166 KB
/
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.3
info:
title: Artifact Hub
description: "Find, install and publish Kubernetes packages"
version: 1.14.0
contact:
name: Artifact Hub support
url: https://cloud-native.slack.com/channels/artifact-hub
servers:
- url: "/api/v1"
tags:
- name: Users
description: ""
- name: Organizations
description: ""
- name: Repositories
description: ""
- name: Packages
description: ""
- name: Subscriptions
description: ""
- name: Webhooks
description: ""
- name: Availability checks
description: ""
- name: Stats
description: ""
- name: Integrations
description: ""
paths:
/users:
post:
tags:
- Users
summary: Register a new user
description: Register a new user
operationId: registerUser
requestBody:
description: ""
required: true
content:
application/json:
schema:
type: object
required:
- alias
- email
- password
properties:
alias:
type: string
example: jdoe
first_name:
type: string
example: John
last_name:
type: string
example: Doe
email:
type: string
format: email
example: jdoe@email.com
password:
type: string
format: password
example: pass123
responses:
"201":
$ref: "#/components/responses/Created"
"400":
$ref: "#/components/responses/BadRequest"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
/users/verify-email:
post:
tags:
- Users
summary: Verify user's email address
description: Verify user's email address
operationId: verifyEmail
requestBody:
content:
application/json:
schema:
type: object
required:
- code
properties:
code:
type: string
format: uuid
responses:
"204":
$ref: "#/components/responses/NoContent"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/UnauthorizedError"
"410":
$ref: "#/components/responses/GoneError"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
/users/profile:
get:
tags:
- Users
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Get user's profile
description: Get user's profile
operationId: getUserProfile
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/User"
"401":
$ref: "#/components/responses/UnauthorizedError"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
put:
tags:
- Users
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Update user's profile
description: Update user's profile
operationId: updateUserProfile
requestBody:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/User"
responses:
"204":
$ref: "#/components/responses/NoContent"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/UnauthorizedError"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
/users/password:
put:
tags:
- Users
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Update user's password
description: Update user's password
operationId: updateUserPassword
requestBody:
description: ""
content:
application/json:
schema:
type: object
required:
- old
- new
properties:
old:
type: string
format: password
new:
type: string
format: password
example:
old: oldPass
new: newPass
responses:
"204":
$ref: "#/components/responses/NoContent"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/UnauthorizedError"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
/users/password-reset-code:
post:
tags:
- Users
summary: Register a code to reset the password
description: Register a code to reset the password
operationId: resetPasswordCode
requestBody:
content:
application/json:
schema:
type: object
required:
- email
properties:
email:
type: string
responses:
"201":
$ref: "#/components/responses/Created"
"400":
$ref: "#/components/responses/BadRequest"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
/users/verify-password-reset-code:
post:
tags:
- Users
summary: Verify a reset password code
description: Verify a reset password code
operationId: verifyPasswordCode
requestBody:
content:
application/json:
schema:
type: object
required:
- code
properties:
code:
type: string
format: uuid
responses:
"200":
description: "The request has succeeded"
"400":
$ref: "#/components/responses/BadRequest"
"410":
$ref: "#/components/responses/GoneError"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
/users/reset-password:
put:
tags:
- Users
summary: Reset the user's password
description: Reset the user's password
operationId: resetPassword
requestBody:
content:
application/json:
schema:
type: object
required:
- code
- password
properties:
code:
type: string
format: uuid
password:
type: string
responses:
"204":
$ref: "#/components/responses/NoContent"
"400":
$ref: "#/components/responses/BadRequest"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
/orgs:
post:
tags:
- Organizations
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Register new organization
description: Register new organization
operationId: addOrganization
requestBody:
description: ""
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/OrganizationSummary"
responses:
"201":
$ref: "#/components/responses/Created"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/UnauthorizedError"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
/orgs/user:
get:
tags:
- Organizations
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Get organizations the user belongs to
description: Get organizations the user belongs to
operationId: getUserOrganizations
parameters:
- $ref: "#/components/parameters/OffsetParam"
- $ref: "#/components/parameters/LimitParam"
responses:
"200":
description: ""
headers:
Pagination-Total-Count:
schema:
type: string
description: Total number of organizations
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Organization"
"401":
$ref: "#/components/responses/UnauthorizedError"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"/orgs/{orgName}":
get:
tags:
- Organizations
summary: Get organization profile
description: Get organization profile
operationId: getOrganizationProfile
parameters:
- $ref: "#/components/parameters/OrgNameParam"
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/OrganizationSummary"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
put:
tags:
- Organizations
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Updates organization profile
description: Updates organization profile
operationId: updateOrganizationProfile
parameters:
- $ref: "#/components/parameters/OrgNameParam"
requestBody:
description: ""
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/OrganizationSummary"
responses:
"204":
$ref: "#/components/responses/NoContent"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
delete:
tags:
- Organizations
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Delete organization
description: Delete organization
operationId: deleteOrganization
parameters:
- $ref: "#/components/parameters/OrgNameParam"
responses:
"204":
$ref: "#/components/responses/NoContent"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"/orgs/{orgName}/authorization-policy":
get:
tags:
- Organizations
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Get organization's authorization policy
description: Get organization's authorization policy
operationId: getOrganizationAuthPolicy
parameters:
- $ref: "#/components/parameters/OrgNameParam"
responses:
"200":
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationPolicy"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
put:
tags:
- Organizations
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Update organization's authorization policy
description: Update organization's authorization policy
operationId: updateOrganizationAuthPolicy
parameters:
- $ref: "#/components/parameters/OrgNameParam"
requestBody:
description: ""
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationPolicy"
responses:
"204":
$ref: "#/components/responses/NoContent"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"/orgs/{orgName}/members":
get:
tags:
- Organizations
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Get organization members
description: Get organization members
operationId: getOrganizationMembers
parameters:
- $ref: "#/components/parameters/OrgNameParam"
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Member"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"/orgs/{orgName}/member/{userAlias}":
post:
tags:
- Organizations
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Add a new member to the organization
description: Add a new member to the organization
operationId: addOrganizationMember
parameters:
- $ref: "#/components/parameters/OrgNameParam"
- $ref: "#/components/parameters/UserAliasParam"
responses:
"201":
$ref: "#/components/responses/Created"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
delete:
tags:
- Organizations
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Delete a member from the organization
description: Delete a member from the organization
operationId: deleteOrganizationMember
parameters:
- $ref: "#/components/parameters/OrgNameParam"
- $ref: "#/components/parameters/UserAliasParam"
responses:
"204":
$ref: "#/components/responses/NoContent"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"/orgs/{orgName}/accept-invitation":
get:
tags:
- Organizations
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Confirm user's membership to an organization
description: Confirm user's membership to an organization
operationId: acceptOrganizationInvitation
parameters:
- $ref: "#/components/parameters/OrgNameParam"
responses:
"204":
$ref: "#/components/responses/NoContent"
"401":
$ref: "#/components/responses/UnauthorizedError"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"/orgs/{orgName}/user-allowed-actions":
get:
tags:
- Organizations
security:
- ApiKeyId: []
ApiKeySecret: []
summary: >-
Get actions which user is allowed to perform in the provided
organization
description: >-
Get actions which user is allowed to perform in the provided
organization
operationId: getAllowedActions
parameters:
- $ref: "#/components/parameters/OrgNameParam"
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/AuthorizerAction"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
/repositories/search:
get:
tags:
- Repositories
summary: Search repositories that meet the provided criteria
description: Search repositories that meet the provided criteria
operationId: searchRepositories
parameters:
- $ref: "#/components/parameters/OffsetParam"
- $ref: "#/components/parameters/LimitParam"
- $ref: "#/components/parameters/RepositoryKindsListParam"
- $ref: "#/components/parameters/UsersListParam"
- $ref: "#/components/parameters/OrgsListParam"
- $ref: "#/components/parameters/RepoNameQueryParam"
- $ref: "#/components/parameters/UrlQueryParam"
responses:
"200":
description: ""
headers:
Pagination-Total-Count:
schema:
type: string
description: Total number of repositories
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Repository"
"401":
$ref: "#/components/responses/UnauthorizedError"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
/repositories/user:
post:
tags:
- Repositories
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Add user's repository
description: Add user's repository
operationId: addUserRepository
requestBody:
$ref: "#/components/requestBodies/RepositoryBody"
responses:
"201":
$ref: "#/components/responses/Created"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/UnauthorizedError"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"/repositories/user/{repoName}":
put:
tags:
- Repositories
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Update user's repository
description: Update user's repository
operationId: updateUserRepository
parameters:
- $ref: "#/components/parameters/RepoNameParam"
requestBody:
$ref: "#/components/requestBodies/RepositoryBody"
responses:
"204":
$ref: "#/components/responses/NoContent"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
delete:
tags:
- Repositories
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Delete user's repository
description: Delete user's repository
operationId: deleteUserRepository
parameters:
- $ref: "#/components/parameters/RepoNameParam"
responses:
"204":
$ref: "#/components/responses/NoContent"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"/repositories/user/{repoName}/transfer":
put:
tags:
- Repositories
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Transfer user's repository ownership to an organization
description: Transfer user's repository ownership to an organization
operationId: transferRepositoryOwnershipToOrganization
parameters:
- $ref: "#/components/parameters/RepoNameParam"
- $ref: "#/components/parameters/OrgNameToParam"
responses:
"204":
$ref: "#/components/responses/NoContent"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"/repositories/user/{repoName}/claim-ownership":
put:
tags:
- Repositories
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Claim the ownership of a given repository
description: Claim the ownership of a given repository
operationId: claimRepositoryOwnership
parameters:
- $ref: "#/components/parameters/RepoNameParam"
- $ref: "#/components/parameters/OrgNameToParam"
responses:
"204":
$ref: "#/components/responses/NoContent"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"/repositories/org/{orgName}":
post:
tags:
- Repositories
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Add organization's repository
description: Add organization's repository
operationId: addOrganizationRepository
parameters:
- $ref: "#/components/parameters/OrgNameParam"
requestBody:
$ref: "#/components/requestBodies/RepositoryBody"
responses:
"201":
$ref: "#/components/responses/Created"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"/repositories/org/{orgName}/{repoName}":
put:
tags:
- Repositories
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Update organization's repository
description: Update organization's repository
operationId: updateOrganizationRepository
parameters:
- $ref: "#/components/parameters/OrgNameParam"
- $ref: "#/components/parameters/RepoNameParam"
requestBody:
$ref: "#/components/requestBodies/RepositoryBody"
responses:
"204":
$ref: "#/components/responses/NoContent"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
delete:
tags:
- Repositories
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Delete organization's repository
description: Delete organization's repository
operationId: deleteOrganizationRepository
parameters:
- $ref: "#/components/parameters/OrgNameParam"
- $ref: "#/components/parameters/RepoNameParam"
responses:
"204":
$ref: "#/components/responses/NoContent"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"/repositories/org/{orgName}/{repoName}/transfer":
put:
tags:
- Repositories
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Transfer organization's repository to a different owner
description: Transfer organization's repository to a different owner
operationId: transferRepositoryOwnership
parameters:
- $ref: "#/components/parameters/OrgNameParam"
- $ref: "#/components/parameters/RepoNameParam"
- $ref: "#/components/parameters/OrgNameToParam"
responses:
"204":
$ref: "#/components/responses/NoContent"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
"/repositories/org/{orgName}/{repoName}/claim-ownership":
put:
tags:
- Repositories
security:
- ApiKeyId: []
ApiKeySecret: []
summary: Claim the ownership of a given repository
description: Claim the ownership of a given repository
operationId: claimRepositoryOwnershipFromOrganization
parameters:
- $ref: "#/components/parameters/OrgNameParam"
- $ref: "#/components/parameters/RepoNameParam"
- $ref: "#/components/parameters/OrgNameToParam"
responses:
"204":
$ref: "#/components/responses/NoContent"
"401":
$ref: "#/components/responses/UnauthorizedError"
"403":
$ref: "#/components/responses/Forbidden"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
/packages/stats:
get:
tags:
- Packages
summary: Get the number of packages and releases registered
description: Get the number of packages and releases registered
operationId: getPackageStats
responses:
"200":
description: ""
content:
application/json:
schema:
type: object
properties:
packages:
type: integer
nullable: false
releases:
type: integer
nullable: false
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
/packages/random:
get:
tags:
- Packages
summary: Get some random packages
description: Get some random packages
operationId: getRandomPackages
responses:
"200":
description: ""
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/PackageSummary"
"429":
$ref: "#/components/responses/TooManyRequests"
"500":
$ref: "#/components/responses/InternalServerError"
/packages/search:
get:
tags:
- Packages
summary: Search packages that meet the provided criteria
description: Search packages that meet the provided criteria
operationId: searchPackages
parameters:
- $ref: "#/components/parameters/OffsetParam"
- $ref: "#/components/parameters/LimitParam"
- $ref: "#/components/parameters/FacetsParam"
- $ref: "#/components/parameters/TSQueryWebParam"
- $ref: "#/components/parameters/RepositoryKindsListParam"
- $ref: "#/components/parameters/PackageCategoryListParam"
- $ref: "#/components/parameters/UsersListParam"
- $ref: "#/components/parameters/OrgsListParam"
- $ref: "#/components/parameters/RepositoriesListParam"
- $ref: "#/components/parameters/LicensesListParam"
- $ref: "#/components/parameters/CapabilitiesListParam"
- $ref: "#/components/parameters/DeprecatedParam"
- $ref: "#/components/parameters/OperatorsParam"
- $ref: "#/components/parameters/VerifiedPublisherParam"
- $ref: "#/components/parameters/OfficialParam"
- $ref: "#/components/parameters/CNCFParam"
- $ref: "#/components/parameters/SortParam"
responses:
"200":
description: ""
headers:
Pagination-Total-Count:
schema:
type: string
description: Total number of packages for this search
content:
application/json:
schema:
type: object
properties:
packages:
type: array
nullable: false
items:
$ref: "#/components/schemas/PackageSummary"
facets:
type: array
nullable: false
items:
$ref: "#/components/schemas/Facets"
examples:
s1:
value:
packages:
- package_id: a9c77b9a-2cd1-4a8f-b9e8-6b8f94e13407
name: artifact-hub
normalized_name: artifact-hub
logo_image_id: 0f5488e2-da57-486b-a20f-bfe746ed3e23
stars: 2
description: >-
Artifact Hub is a web-based application that enables
finding, installing, and publishing Kubernetes
packages.
version: 0.1.0
app_version: 0.1.0
deprecated: false
ts: 1617098261617098268
repository:
url: "http://url.com"
kind: 0
name: artifact-hub
display_name: Artifact Hub