-
Notifications
You must be signed in to change notification settings - Fork 0
/
swaggerhub.yml
1025 lines (1014 loc) · 27.5 KB
/
swaggerhub.yml
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
swagger: '2.0'
info:
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
description: >
## NOTE: this API definition differs from the original definition released by Swaggerhub at https://app.swaggerhub.com/apis/swagger-hub/registry-api/1.0.46.
* Operation names were changed to snake case to conform to Transposit's style guide.
# Introduction
This is the registry API for SwaggerHub. It allows you to access, manage,
and update your APIs and Domains in SwaggerHub bypassing the Web
application.
# Authentication
Use your personal API Key: you can find it by visiting the [API Key
page](https://app.swaggerhub.com/settings/apiKey).
version: 1.0.46
title: SwaggerHub Registry API
contact:
name: SwaggerHub
url: 'https://swaggerhub.com'
email: [email protected]
host: api.swaggerhub.com
tags:
- name: APIs
description: Operations for APIs
- name: Domains
description: Operations for Domains
schemes:
- https
produces:
- application/json
externalDocs:
url: https://app.swaggerhub.com/apis/swagger-hub/registry-api/1.0.46
paths:
/specs:
get:
tags:
- APIs
- Domains
summary: >-
Retrieves a list of currently defined APIs and Domains in APIs.json
format
description: ''
operationId: search_apis_and_domains
parameters:
- name: specType
in: query
description: |
Type of Swagger specs to search:
* API - APIs only
* DOMAIN - Domains only
* ANY - Both APIs and Domains
required: false
type: string
default: ANY
enum:
- API
- DOMAIN
- ANY
- name: visibility
in: query
description: >
The visibility of a spec in SwaggerHub:
* PUBLIC - can be viewed by anyone
* PRIVATE - can only be viewed by you or your Org and those that you
are collaborating with or have shared it with
* ANY - either PUBLIC or PRIVATE
required: false
type: string
default: ANY
enum:
- PUBLIC
- PRIVATE
- ANY
- $ref: '#/parameters/state'
- name: owner
in: query
description: >-
API or Domain owner identifier. Can be username or organization
name
required: false
type: string
- $ref: '#/parameters/query'
- $ref: '#/parameters/page'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/sort'
- $ref: '#/parameters/order'
responses:
'200':
description: A list of APIs and Domains in APIs.json format
schema:
$ref: '#/definitions/ApisJson'
security:
- TokenSecured: []
/apis:
get:
tags:
- APIs
summary: Retrieves a list of currently defined APIs in APIs.json format.
description: ''
operationId: search_apis
parameters:
- $ref: '#/parameters/query'
- $ref: '#/parameters/state'
- name: tag
in: query
description: Matches against tags associated with an API
required: false
type: array
items:
type: string
collectionFormat: multi
- $ref: '#/parameters/page'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/sort'
- $ref: '#/parameters/order'
responses:
'303':
description: 303 response
headers:
Location:
type: string
security:
- TokenSecured: []
'/apis/{owner}':
get:
tags:
- APIs
summary: Retrieves an APIs.json listing of all APIs defined for this owner
description: ''
operationId: get_owner_apis
parameters:
- $ref: '#/parameters/apiOwner'
- $ref: '#/parameters/page'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/sort'
- $ref: '#/parameters/order'
responses:
'200':
description: A list of APIs in APIs.json format
schema:
$ref: '#/definitions/ApisJson'
security:
- TokenSecured: []
'/apis/{owner}/{api}':
get:
tags:
- APIs
summary: >-
Retrieves an APIs.json listing for all API versions for this owner and
API
operationId: get_api_versions
parameters:
- $ref: '#/parameters/apiOwner'
- $ref: '#/parameters/api'
responses:
'200':
description: A list of API versions in APIs.json format
schema:
$ref: '#/definitions/ApisJson'
security:
- TokenSecured: []
post:
tags:
- APIs
summary: Saves the provided Swagger definition
description: >-
Saves the provided Swagger definition; the owner must match the token
owner. The version will be extracted from the Swagger definition
itself.
operationId: save_definition
consumes:
- application/json
- application/yaml
parameters:
- $ref: '#/parameters/apiOwner'
- $ref: '#/parameters/api'
- name: isPrivate
in: query
description: Defines whether the API has to be private
required: false
type: boolean
default: false
- name: version
in: query
description: API version
required: false
type: string
- in: body
name: definition
description: The Swagger definition of this API
required: true
schema:
type: string
- name: force
in: query
description: Force update
required: false
type: boolean
responses:
'200':
description: The API was successfully saved
'201':
description: New API was successfully saved
'205':
description: The API was successfully saved and should be reloaded
'400':
description: The Swagger definition was invalid
'403':
description: Maximum number of APIs reached
'409':
description: Cannot overwrite a published API version
'415':
description: Invalid content type
security:
- TokenSecured: []
delete:
tags:
- APIs
summary: Deletes the specified API
description: ''
operationId: delete_api
parameters:
- $ref: '#/parameters/apiOwner'
- $ref: '#/parameters/api'
responses:
'200':
description: The API was successfully deleted
'403':
description: Access denied
'404':
description: The specified API not found
'409':
description: The API has published versions and cannot be deleted
security:
- TokenSecured: []
'/apis/{owner}/{api}/.collaboration':
get:
tags:
- APIs
summary: Gets API's collaboration
operationId: get_collaboration
parameters:
- $ref: '#/parameters/apiOwner'
- $ref: '#/parameters/api'
- name: expandTeams
in: query
required: false
type: boolean
default: false
responses:
'200':
description: The existing collaboration on an API
schema:
$ref: '#/definitions/Collaboration'
security:
- TokenSecured: []
put:
tags:
- APIs
summary: Updates API's collaboration
operationId: update_collaboration
parameters:
- $ref: '#/parameters/apiOwner'
- $ref: '#/parameters/api'
- in: body
name: body
required: false
schema:
$ref: '#/definitions/Collaboration'
responses:
default:
description: Successfully updated API collaboration
security:
- TokenSecured: []
delete:
tags:
- APIs
summary: Deletes API's collaboration
operationId: delete_collaboration
parameters:
- $ref: '#/parameters/apiOwner'
- $ref: '#/parameters/api'
responses:
default:
description: Successfully deleted a collaboration
security:
- TokenSecured: []
'/apis/{owner}/{api}/{version}':
get:
tags:
- APIs
summary: Retrieves the Swagger definition for the specified API and version
description: ''
operationId: get_definition
produces:
- application/json
- application/yaml
parameters:
- $ref: '#/parameters/apiOwner'
- $ref: '#/parameters/api'
- $ref: '#/parameters/version'
responses:
'200':
description: The Swagger API in requested format
schema:
type: object
properties: {}
'404':
description: The specified API not found
security:
- TokenSecured: []
delete:
tags:
- APIs
summary: Deletes a particular version of the specified API
description: ''
operationId: delete_api_version
parameters:
- $ref: '#/parameters/apiOwner'
- $ref: '#/parameters/api'
- $ref: '#/parameters/version'
responses:
'200':
description: The API version was successfully deleted
'403':
description: Access denied
'404':
description: The specified API was not found
'409':
description: >-
The API version is published and cannot be deleted or it is the
only version of this API
security:
- TokenSecured: []
'/apis/{owner}/{api}/{version}/swagger.json':
get:
tags:
- APIs
summary: >-
Retrieves the Swagger definition for the specified API and version in
JSON format
description: ''
operationId: get_json_definition
parameters:
- $ref: '#/parameters/apiOwner'
- $ref: '#/parameters/api'
- $ref: '#/parameters/version'
responses:
'200':
description: The Swagger API in JSON format
schema:
type: object
properties: {}
'404':
description: The specified API was not found
security:
- TokenSecured: []
'/apis/{owner}/{api}/{version}/swagger.yaml':
get:
tags:
- APIs
summary: >-
Retrieves the Swagger definition for the specified API and version in
YAML format
description: ''
operationId: get_yaml_definition
produces:
- application/yaml
parameters:
- $ref: '#/parameters/apiOwner'
- $ref: '#/parameters/api'
- $ref: '#/parameters/version'
responses:
'200':
description: The Swagger API in YAML format
schema:
type: object
properties: {}
'404':
description: The specified API was not found
security:
- TokenSecured: []
'/apis/{owner}/{api}/{version}/.comment':
get:
tags:
- APIs
summary: Returns comments for the specified API version
operationId: get_api_comments
description: >
Returns all the comments and replies added by collaborators in the
specified API version.
parameters:
- $ref: '#/parameters/apiOwner'
- $ref: '#/parameters/api'
- $ref: '#/parameters/version'
responses:
'200':
description: A list of comments for the specified API version
schema:
type: array
items:
$ref: '#/definitions/ClosableComment'
'204':
description: No comments were found for the specified API version
'401':
description: The access token is missing or invalid
'403':
description: Access denied (insufficient user permissions)
'404':
description: The specified API or version was not found
security:
- TokenSecured: []
/domains:
get:
tags:
- Domains
summary: Retrieves a list of currently defined domains in APIs.json format
operationId: search_domains
parameters:
- $ref: '#/parameters/query'
- $ref: '#/parameters/state'
- name: tag
in: query
description: Matches against tags associated with a domain
required: false
type: array
items:
type: string
collectionFormat: multi
- $ref: '#/parameters/page'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/sort'
- $ref: '#/parameters/order'
responses:
'303':
description: 303 response
headers:
Location:
type: string
security:
- TokenSecured: []
'/domains/{owner}':
get:
tags:
- Domains
summary: Retrieves an APIs.json listing of all domains defined for this owner
operationId: get_owner_domains
parameters:
- $ref: '#/parameters/domainOwner'
- $ref: '#/parameters/page'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/sort'
- $ref: '#/parameters/order'
responses:
'200':
description: A list of domains in APIs.json format
schema:
$ref: '#/definitions/ApisJson'
security:
- TokenSecured: []
'/domains/{owner}/{domain}':
get:
tags:
- Domains
summary: >-
Retrieves an APIs.json listing for all domain versions for this owner
and domain
operationId: get_domain_versions
parameters:
- $ref: '#/parameters/domainOwner'
- $ref: '#/parameters/domain'
responses:
'200':
description: A list of domain versions in APIs.json format
schema:
$ref: '#/definitions/ApisJson'
security:
- TokenSecured: []
post:
tags:
- Domains
summary: Saves the provided Swagger definition of a domain
operationId: save_domain_definition
consumes:
- application/json
- application/yaml
parameters:
- $ref: '#/parameters/domainOwner'
- $ref: '#/parameters/domain'
- name: isPrivate
in: query
description: Specifies whether the domain has to be private
required: false
type: boolean
default: false
- name: version
in: query
description: Domain version
required: true
type: string
- in: body
name: definition
description: The Swagger definition of this domain
required: false
schema:
type: string
- name: force
in: query
description: Force update
required: false
type: boolean
responses:
'200':
description: The domain was successfully saved
'201':
description: New domain was successfully saved
'205':
description: The domain was successfully saved and should be reloaded
'403':
description: Maximum number of domains reached
'409':
description: Cannot overwrite a published domain version
'415':
description: Invalid content type
security:
- TokenSecured: []
delete:
tags:
- Domains
summary: Deletes the specified domain
operationId: delete_domain
parameters:
- $ref: '#/parameters/domainOwner'
- $ref: '#/parameters/domain'
- name: force
in: query
description: Force update
required: false
type: boolean
responses:
'200':
description: The domain was successfully deleted
'403':
description: Access denied
'404':
description: The specified domain not found
'409':
description: The domain has published versions and can not be deleted
'424':
description: Cannot delete because there are some dependencies for domain
schema:
$ref: '#/definitions/Page'
security:
- TokenSecured: []
'/domains/{owner}/{domain}/{version}':
get:
tags:
- Domains
summary: Retrieves the Swagger definition for the specified domain and version
operationId: get_domain_definition
produces:
- application/json
- application/yaml
parameters:
- $ref: '#/parameters/domainOwner'
- $ref: '#/parameters/domain'
- $ref: '#/parameters/version'
responses:
'200':
description: The Swagger domain in requested format
schema:
type: object
properties: {}
'404':
description: The specified domain was not found
security:
- TokenSecured: []
delete:
tags:
- Domains
summary: Deletes a particular version of the specified domain
operationId: delete_domain_version
parameters:
- $ref: '#/parameters/domainOwner'
- $ref: '#/parameters/domain'
- $ref: '#/parameters/version'
- name: force
in: query
description: Force update
required: false
type: boolean
responses:
'200':
description: The domain version was successfully deleted
'403':
description: Access denied
'404':
description: The specified domain was not found
'409':
description: >-
The domain version is published and can not be deleted or it is the
only version of this API
'424':
description: Cannot delete because there are some dependencies for domain
schema:
$ref: '#/definitions/Page'
security:
- TokenSecured: []
'/domains/{owner}/{domain}/{version}/domain.json':
get:
tags:
- Domains
summary: >-
Retrieves the definition for the specified domain and version in JSON
format
operationId: get_domain_json_definition
parameters:
- $ref: '#/parameters/domainOwner'
- $ref: '#/parameters/domain'
- $ref: '#/parameters/version'
responses:
'200':
description: Definition in JSON format
schema:
type: object
properties: {}
'404':
description: The specified domain was not found
security:
- TokenSecured: []
'/domains/{owner}/{domain}/{version}/domain.yaml':
get:
tags:
- Domains
summary: >-
Retrieves the definition for the specified domain and version in YAML
format
operationId: get_domain_yaml_definition
produces:
- application/yaml
parameters:
- $ref: '#/parameters/domainOwner'
- $ref: '#/parameters/domain'
- $ref: '#/parameters/version'
responses:
'200':
description: Definition in YAML format
schema:
type: object
properties: {}
'404':
description: The specified domain was not found
security:
- TokenSecured: []
'/domains/{owner}/{domain}/{version}/.comment':
get:
tags:
- Domains
summary: Returns comments for the specified domain version
operationId: get_domain_comments
description: >
Returns all the comments and replies added by collaborators in the
specified domain version.
parameters:
- $ref: '#/parameters/domainOwner'
- $ref: '#/parameters/domain'
- $ref: '#/parameters/version'
responses:
'200':
description: Comments for the specified domain
schema:
type: array
items:
$ref: '#/definitions/ClosableComment'
'204':
description: No comments were found for the specified domain version
'401':
description: The access token is missing or invalid
'403':
description: Access denied (insufficient user permissions)
'404':
description: The specified domain or version was not found
security:
- TokenSecured: []
securityDefinitions:
TokenSecured:
type: apiKey
name: Authorization
in: header
description: Specify your SwaggerHub API key found in https://app.swaggerhub.com/settings/apiKey.
parameters:
apiOwner:
name: owner
in: path
description: API owner (user or organization, case-sensitive)
required: true
type: string
domainOwner:
name: owner
in: path
description: Domain owner (user or organization, case-sensitive)
required: true
type: string
api:
name: api
in: path
description: API name (case-sensitive)
required: true
type: string
domain:
name: domain
in: path
description: Domain name (case-sensitive)
required: true
type: string
version:
name: version
in: path
description: Version identifier (case-sensitive)
required: true
type: string
query:
name: query
in: query
description: Free text query to match
required: false
type: string
state:
name: state
in: query
description: >
Matches against published state of the spec:
* UNPUBLISHED - spec is a draft, a work in progress
* PUBLISHED - spec is a stable version ready for consuming from
client applications
* ANY - either PUBLISHED or UNPUBLISHED
required: false
type: string
default: ALL
enum:
- ALL
- PUBLISHED
- UNPUBLISHED
page:
name: page
in: query
description: Page to return
required: false
type: integer
default: 0
format: int32
limit:
name: limit
in: query
description: Number of results per page
required: false
type: integer
default: 10
format: int32
sort:
name: sort
in: query
description: |
Sort criteria or result set:
* NAME
* UPATED
* CREATED
* OWNER
required: false
type: string
default: NAME
enum:
- NAME
- UPDATED
- CREATED
- OWNER
order:
name: order
in: query
description: Sort order
required: false
type: string
default: ASC
enum:
- ASC
- DESC
definitions:
ApisJsonProperty:
type: object
properties:
type:
type: string
description: an API property
ApisJson:
type: object
properties:
name:
type: string
example: Default listing
description:
type: string
example: Default registry listing
url:
type: string
created:
type: string
format: date-time
modified:
type: string
format: date-time
specificationVersion:
type: string
offset:
type: integer
format: int32
totalCount:
type: integer
format: int64
apis:
type: array
items:
$ref: '#/definitions/ApisJsonApi'
ApisJsonApi:
type: object
properties:
name:
type: string
example: petstore
description:
type: string
example: This is a sample Petstore server.
tags:
type: array
uniqueItems: true
items:
type: string
properties:
type: array
items:
$ref: '#/definitions/ApisJsonProperty'
example:
- type: Swagger
url: 'https://api.swaggerhub.com/apis/username/petstore/1.1'
- type: X-Version
value: '1.1'
- type: X-Created
value: '2017-01-16T13:39:06Z'
- type: X-Modified
value: '2017-01-25T11:48:13Z'
- type: X-Published
value: 'true'
- type: X-Versions
value: '1.0,*1.1,1.1-oas3'
- type: X-Private
value: 'false'
- type: X-Notifications
value: 'true'
User:
type: object
description: The user who added a comment
properties:
id:
type: string
description: User name
example: alex
active:
type: boolean
description: >
`true` means an existing user, `false` means the user is inactive
(for example, deleted)
Comment:
type: object
required:
- body
- created
- id
- user
properties:
id:
type: string
description: The unique ID of the comment
example: '141b0adb-f26a-438b-be78-906445c91a36'
user:
$ref: '#/definitions/User'
created:
type: string
format: date-time
description: The UTC date and time when the comment was added
modified:
type: string
format: date-time
description: The UTC date and time the when the comment was last edited
body:
type: string
description: Markdown contents of the comment
ClosableComment:
allOf:
- $ref: '#/definitions/Comment'
- type: object
properties:
position:
type: integer
format: int32
description: >
The line number (zero-based) the comment is associated with.
For example, if the comment is on line 7 in the editor, `position`=6.
status:
type: string
description: Comment status
enum:
- OPEN
- RESOLVED
replies:
type: array
description: A list of replies to this comment
items:
$ref: '#/definitions/Comment'
Collaboration:
type: object
required:
- hint
properties:
owner:
type: string
readOnly: true
owners:
type: array
items:
type: string
hint:
$ref: '#/definitions/CollaborationHint'
members:
type: array
items:
$ref: '#/definitions/CollaborationMembership'
pendingMembers:
type: array
items:
$ref: '#/definitions/CollaborationMembership'
teams:
type: array
items:
$ref: '#/definitions/CollaborationTeamMembership'
CollaborationTeamMembership:
allOf:
- $ref: '#/definitions/CollaborationMembership'
- type: object
properties:
members:
type: array
items:
$ref: '#/definitions/CollaborationMember'
CollaborationHint:
type: object
required:
- type
properties:
type:
type: string
format: uuid
description: type identifier of the managed entity
CollaborationMembership:
allOf:
- $ref: '#/definitions/CollaborationMember'
- type: object
required:
- roles
properties:
roles:
type: array
items:
type: string
enum:
- EDIT
- COMMENT
- VIEW
donotdisturb:
type: boolean
readOnly: true
blocked:
type: boolean
readOnly: true
CollaborationMember:
type: object
required:
- name
properties:
uuid: