-
Notifications
You must be signed in to change notification settings - Fork 0
/
discovery.formatted.yaml
6177 lines (6175 loc) · 176 KB
/
discovery.formatted.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
basePath: /
definitions:
AddLabel:
description: Adds a label to a manifest
properties:
key:
description: The key for the label
type: string
media_type:
description: The media type for this label
enum:
- text/plain
- application/json
- null
type:
- string
- 'null'
value:
description: The value for the label
type: string
required:
- key
- value
- media_type
type: object
ApiError:
properties:
detail:
description: Details about the specific instance of the error.
type: string
error_message:
description: Deprecated; alias for detail
type: string
error_type:
description: Deprecated; alias for detail
type: string
status:
description: Status code of the response.
type: integer
title:
description: Unique error code to identify the type of error.
type: string
type:
description: Reference to the type of the error.
type: string
required:
- status
- type
- title
type: object
ApiErrorDescription:
description: Description of an error
properties:
description:
description: A more detailed description of the error that may include help for fixing the issue.
type: string
title:
description: The title of the error. Can be used to uniquely identify the kind of error.
enum:
- downstream_issue
- exceeds_license
- expired_token
- external_service_timeout
- fresh_login_required
- insufficient_scope
- invalid_request
- invalid_response
- invalid_token
- not_found
type: string
type:
description: A reference to the error type resource
type: string
required:
- type
- description
- title
type: object
Avatar:
description: Dockstore observed return object
properties:
color:
description: TBD
type: string
kind:
description: TBD
type: string
hash:
description: TBD
type: string
name:
description: TBD
type: string
BuildTriggerActivateRequest:
properties:
config:
description: Arbitrary json.
type: object
pull_robot:
description: The name of the robot that will be used to pull images.
type: string
required:
- config
type: object
ChangeRepoTrust:
description: Change the trust settings for the repository.
properties:
trust_enabled:
description: Whether or not signing is enabled for the repository.
type: boolean
required:
- trust_enabled
type: object
ChangeTag:
description: Makes changes to a specific tag
properties:
expiration:
description: (If specified) The expiration for the image
type:
- number
- 'null'
image:
description: (If specified) Image identifier to which the tag should point
type:
- string
- 'null'
type: object
ChangeVisibility:
description: Change the visibility for the repository.
properties:
visibility:
description: Visibility which the repository will start with
enum:
- public
- private
type: string
required:
- visibility
type: object
CreateMessage:
description: Create a new message
id: CreateMessage
properties:
message:
description: A single message
properties:
content:
description: The actual message
type: string
media_type:
description: The media type of the message
enum:
- text/plain
- text/markdown
type: string
severity:
description: The severity of the message
enum:
- info
- warning
- error
type: string
required:
- content
- media_type
- severity
type: object
type: object
CreateRobot:
description: Optional data for creating a robot
properties:
description:
description: Optional text description for the robot
maxLength: 255
type: string
unstructured_metadata:
description: Optional unstructured metadata for the robot
type: object
type: object
NewApp:
description: Description of a new organization application.
properties:
application_uri:
description: The URI for the application's homepage
type: string
avatar_email:
description: The e-mail address of the avatar to use for the application
type: string
description:
description: The human-readable description for the application
type: string
name:
description: The name of the application
type: string
redirect_uri:
description: The URI for the application's OAuth redirect
type: string
required:
- name
type: object
NewOrg:
description: Description of a new organization.
properties:
email:
description: Organization contact email
type: string
name:
description: Organization username
type: string
required:
- name
type: object
NewPrototype:
description: Description of a new prototype
properties:
activating_user:
description: Repository creating user to whom the rule should apply
properties:
name:
description: The username for the activating_user
type: string
required:
- name
type: object
delegate:
description: Information about the user or team to which the rule grants access
properties:
kind:
description: Whether the delegate is a user or a team
enum:
- user
- team
type: string
name:
description: The name for the delegate team or user
type: string
required:
- name
- kind
type: object
role:
description: Role that should be applied to the delegate
enum:
- read
- write
- admin
type: string
required:
- role
- delegate
type: object
NewRepo:
description: Description of a new repository
properties:
description:
description: Markdown encoded description for the repository
type: string
namespace:
description: 'Namespace in which the repository should be created. If omitted, the username of the caller is used'
type: string
repo_kind:
description: The kind of repository
enum:
- image
- application
- null
type:
- string
- 'null'
repository:
description: Repository name
type: string
visibility:
description: Visibility which the repository will start with
enum:
- public
- private
type: string
required:
- repository
- visibility
- description
type: object
NewStarredRepository:
properties:
namespace:
description: Namespace in which the repository belongs
type: string
repository:
description: Repository name
type: string
required:
- namespace
- repository
type: object
NewToken:
description: Description of a new token.
properties:
friendlyName:
description: Friendly name to help identify the token
type: string
required:
- friendlyName
type: object
NewUser:
description: Fields which must be specified for a new user.
properties:
email:
description: The user's email address
type: string
invite_code:
description: The optional invite code
type: string
password:
description: The user's password
type: string
recaptcha_response:
description: The (may be disabled) recaptcha response code for verification
type: string
username:
description: The user's username
type: string
required:
- username
- password
type: object
NotificationCreateRequest:
description: Information for creating a notification on a repository
properties:
config:
description: JSON config information for the specific method of notification
type: object
event:
description: The event on which the notification will respond
type: string
eventConfig:
description: JSON config information for the specific event of notification
type: object
method:
description: The method of notification (such as email or web callback)
type: string
title:
description: The human-readable title of the notification
type: string
required:
- event
- method
- config
- eventConfig
type: object
QuayBuild:
description: Dockstore observed return object for builds
properties:
status:
description: TBD
type: object
error:
description: TBD
type: object
display_name:
description: TBD
type: string
repository:
description: TBD
type: object
properties:
namespace:
description: TBD
type: string
name:
description: TBD
type: string
subdirectory:
description: TBD
type: string
started:
description: TBD
type: string
tags:
description: TBD
type: array
items:
type: string
pull_robot:
description: TBD
$ref: "#/definitions/PullRobot"
trigger:
description: TBD
type: object
properties:
disabled_reason:
description: TBD
type: object
service:
description: TBD
type: string
can_invoke:
description: TBD
type: boolean
repository_url:
description: TBD
type: string
build_source:
description: TBD
type: string
config:
description: TBD
type: object
is_active:
description: TBD
type: boolean
id:
description: TBD
type: string
enabled:
description: TBD
type: string
trigger_metadata:
description: TBD
type: object
properties:
default_branch:
description: TBD
type: string
commit:
description: TBD
type: string
ref:
description: TBD
type: string
git_url:
description: TBD
type: string
commit_info:
description: TBD
type: object
properties:
url:
description: TBD
type: string
date:
description: TBD
type: string
message:
description: TBD
type: string
author:
description: TBD
type: object
properties:
username:
description: TBD
type: string
committer:
description: TBD
type: object
properties:
username:
description: TBD
type: string
context:
description: TBD
type: string
is_writer:
description: TBD
type: boolean
phase:
description: TBD
type: string
resource_key:
description: TBD
type: object
manual_user:
description: TBD
type: object
id:
description: TBD
type: string
dockerfile_path:
description: TBD
type: string
type: object
QuayOrganization:
description: Dockstore observed return object for organization
properties:
public:
description: TBD
type: boolean
can_create_repo:
description: TBD
type: boolean
name:
description: TBD
type: string
avatar:
$ref: "#/definitions/Avatar"
type: object
PrototypeUpdate:
description: Description of a the new prototype role
properties:
role:
description: Role that should be applied to the permission
enum:
- read
- write
- admin
type: string
required:
- role
type: object
PullRobot:
description: Dockstore observed return object of pull_robot
properties:
kind:
description: TBD
type: string
name:
description: TBD
type: string
is_robot:
description: TBD
type: boolean
type: object
QuayRepo:
description: Dockstore observed return object
properties:
trust_enabled:
description: TBD
type: boolean
description:
description: TBD
type: string
tags:
type: object
additionalProperties:
$ref: "#/definitions/QuayTag"
tag_expiration_s:
description: TBD
type: long
is_public:
description: TBD
type: boolean
is_starred:
description: TBD
type: boolean
is_free_account:
description: TBD
type: boolean
kind:
description: TBD
type: string
name:
description: TBD
type: string
namespace:
description: TBD
type: string
is_organization:
description: TBD
type: boolean
state:
description: TBD
type: string
can_write:
description: TBD
type: boolean
status_token:
description: TBD
type: string
can_admin:
description: TBD
type: boolean
type: object
QuayRepoManifest:
description: Describes the manifest data of a particular Quay tag.
properties:
digest:
description: The digest of the manifest
type: string
is_manifest_list:
description: Whether this manifest contains a list of one or more image layers
type: boolean
manifest_data:
description: Actual list of image layers that contains info about the multi-arch/platform specific versions of the image. String follows JSON formatting.
type: string
type: object
QuayTag:
description: Dockstore observed return object
properties:
image_id:
description: TBD
type: string
last_modified:
description: TBD
type: string
name:
description: TBD
type: string
manifest_digest:
description: TBD
type: string
size:
description: TBD
type: integer
format: int64
is_manifest_list:
description: TBD
type: boolean
type: object
RepoUpdate:
description: Fields which can be updated in a repository.
properties:
description:
description: Markdown encoded description for the repository
type: string
required:
- description
type: object
RepositoryBuildRequest:
description: Description of a new repository build.
properties:
archive_url:
description: The URL of the .tar.gz to build. Must start with "http" or "https".
type: string
context:
description: Pass in the context for the dockerfile. This is optional.
type: string
docker_tags:
description: 'The tags to which the built images will be pushed. If none specified, "latest" is used.'
items:
type: string
minItems: 1
type: array
uniqueItems: true
dockerfile_path:
description: Path to a dockerfile. You can only specify this or subdirectory.
type: string
file_id:
description: The file id that was generated when the build spec was uploaded
type: string
pull_robot:
description: Username of a Quay robot account to use as pull credentials
$ref: "#/definitions/PullRobot"
subdirectory:
description: Subdirectory in which the Dockerfile can be found. You can only specify this or dockerfile_path
type: string
type: object
RestoreTag:
description: Restores a tag to a specific image
properties:
image:
description: Image identifier to which the tag should point
type: string
manifest_digest:
description: 'If specified, the manifest digest that should be used'
type: string
required:
- image
type: object
RunParameters:
additionalProperties: false
description: Optional run parameters for activating the build trigger
properties:
branch_name:
description: '(SCM only) If specified, the name of the branch to build.'
type: string
commit_sha:
description: '(Custom Only) If specified, the ref/SHA1 used to checkout a git repository.'
type: string
refs:
description: '(SCM Only) If specified, the ref to build.'
type:
- object
- 'null'
type: object
TeamDescription:
description: Description of a team
properties:
description:
description: Markdown description for the team
type: string
role:
description: Org wide permissions that should apply to the team
enum:
- member
- creator
- admin
type: string
required:
- role
type: object
TeamPermission:
description: Description of a team permission.
properties:
role:
description: Role to use for the team
enum:
- read
- write
- admin
type: string
required:
- role
type: object
TokenPermission:
description: Description of a token permission
properties:
role:
description: Role to use for the token
enum:
- read
- write
- admin
type: string
required:
- role
type: object
UpdateApp:
description: Description of an updated application.
properties:
application_uri:
description: The URI for the application's homepage
type: string
avatar_email:
description: The e-mail address of the avatar to use for the application
type: string
description:
description: The human-readable description for the application
type: string
name:
description: The name of the application
type: string
redirect_uri:
description: The URI for the application's OAuth redirect
type: string
required:
- name
- redirect_uri
- application_uri
type: object
UpdateOrg:
description: Description of updates for an existing organization
properties:
email:
description: Organization contact email
type: string
invoice_email:
description: Whether the organization desires to receive emails for invoices
type: boolean
invoice_email_address:
description: The email address at which to receive invoices
type:
- string
- 'null'
tag_expiration_s:
description: The number of seconds for tag expiration
minimum: 0
type: integer
type: object
UpdateTrigger:
description: Options for updating a build trigger
properties:
enabled:
description: Whether the build trigger is enabled
type: boolean
required:
- enabled
type: object
UpdateUser:
description: Fields which can be updated in a user.
properties:
company:
description: The optional entered company for the user
type:
- string
- 'null'
email:
description: The user's email address
type: string
family_name:
description: The optional entered family name for the user
type:
- string
- 'null'
given_name:
description: The optional entered given name for the user
type:
- string
- 'null'
invoice_email:
description: Whether the user desires to receive an invoice email.
type: boolean
invoice_email_address:
description: Custom email address for receiving invoices
type:
- string
- 'null'
location:
description: The optional entered location for the user
type:
- string
- 'null'
password:
description: The user's password
type: string
tag_expiration_s:
description: The number of seconds for tag expiration
minimum: 0
type: integer
username:
description: The user's username
type: string
type: object
UserPermission:
description: Description of a user permission.
properties:
role:
description: Role to use for the user
enum:
- read
- write
- admin
type: string
required:
- role
type: object
UserView:
description: Describes a user
properties:
anonymous:
description: true if this user data represents a guest user
type: boolean
avatar:
description: Avatar data representing the user's icon
type: object
can_create_repo:
description: Whether the user has permission to create repositories
type: boolean
email:
description: The user's email address
type: string
logins:
description: The list of external login providers against which the user has authenticated
items:
type: object
type: array
organizations:
description: Information about the organizations in which the user is a member
items:
$ref: "#/definitions/QuayOrganization"
type: array
preferred_namespace:
description: 'If true, the user''s namespace is the preferred namespace to display'
type: boolean
verified:
description: Whether the user's email address has been verified
type: boolean
required:
- anonymous
- avatar
type: object
host: quay.io
info:
contact:
email: [email protected]
description: 'This API allows you to perform many of the operations required to work with Quay repositories, users, and organizations. You can find out more at <a href="https://quay.io">Quay</a>.'
termsOfService: 'https://quay.io/tos'
title: Quay Frontend
version: v1
paths:
'/api/v1/app/{client_id}':
get:
description: Get information on the specified application.
operationId: getApplicationInformation
parameters:
- description: The OAuth client ID
in: path
name: client_id
required: true
type: string
responses:
'200':
description: Successful invocation
'400':
description: Bad Request
schema:
$ref: '#/definitions/ApiError'
'401':
description: Session required
schema:
$ref: '#/definitions/ApiError'
'403':
description: Unauthorized access
schema:
$ref: '#/definitions/ApiError'
'404':
description: Not found
schema:
$ref: '#/definitions/ApiError'
tags:
- organization
parameters:
- description: The OAuth client ID
in: path
name: client_id
required: true
type: string
x-name: endpoints.api.organization.ApplicationInformation
x-path: '/api/v1/app/{client_id}'
x-tag: organization
/api/v1/discovery:
get:
description: List all of the API endpoints available in the swagger API format.
operationId: discovery
parameters:
- description: Whether to include internal APIs.
in: query
name: internal
required: false
type: boolean
responses:
'200':
description: Successful invocation
'400':
description: Bad Request
schema:
$ref: '#/definitions/ApiError'
'401':
description: Session required
schema:
$ref: '#/definitions/ApiError'
'403':
description: Unauthorized access
schema:
$ref: '#/definitions/ApiError'
'404':
description: Not found
schema:
$ref: '#/definitions/ApiError'
tags:
- discovery
x-name: endpoints.api.discovery.DiscoveryResource
x-path: /api/v1/discovery
x-tag: discovery
'/api/v1/entities/{prefix}':
get:
description: Get a list of entities that match the specified prefix.
operationId: getMatchingEntities
parameters:
- description: ''
in: path
name: prefix
required: true
type: string
- description: Whether to include orgs names.
in: query
name: includeOrgs
required: false
type: boolean
- description: Whether to include team names.
in: query
name: includeTeams
required: false
type: boolean
- description: Namespace to use when querying for org entities.
in: query
name: namespace
required: false
type: string
responses:
'200':
description: Successful invocation
'400':
description: Bad Request
schema:
$ref: '#/definitions/ApiError'
'401':
description: Session required
schema:
$ref: '#/definitions/ApiError'
'403':
description: Unauthorized access
schema:
$ref: '#/definitions/ApiError'
'404':
description: Not found
schema:
$ref: '#/definitions/ApiError'
tags:
- search
x-name: endpoints.api.search.EntitySearch
x-path: '/api/v1/entities/{prefix}'
x-tag: search
'/api/v1/error/{error_type}':
get:
description: Get a detailed description of the error
operationId: getErrorDescription
parameters:
- description: The error code identifying the type of error.