swaggerhub-cli 0.13.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +209 -122
- package/oclif.manifest.json +247 -86
- package/package.json +2 -2
- package/src/commands/api/clone.js +65 -0
- package/src/commands/api/create.js +2 -2
- package/src/commands/api/delete.js +1 -1
- package/src/commands/api/get.js +2 -2
- package/src/commands/api/publish.js +1 -1
- package/src/commands/api/setdefault.js +1 -1
- package/src/commands/api/update.js +3 -3
- package/src/commands/api/validate/download-rules.js +5 -5
- package/src/commands/api/validate/index.js +2 -2
- package/src/commands/api/validate/local.js +3 -3
- package/src/commands/configure.js +2 -2
- package/src/commands/domain/clone.js +65 -0
- package/src/commands/domain/create.js +6 -6
- package/src/commands/domain/delete.js +1 -1
- package/src/commands/domain/get.js +1 -1
- package/src/commands/domain/publish.js +1 -1
- package/src/commands/domain/rename.js +77 -0
- package/src/commands/domain/setdefault.js +1 -1
- package/src/commands/domain/unpublish.js +1 -1
- package/src/commands/domain/update.js +3 -3
- package/src/commands/integration/create.js +2 -2
- package/src/commands/integration/delete.js +1 -1
- package/src/commands/integration/execute.js +1 -1
- package/src/commands/integration/get.js +2 -2
- package/src/commands/integration/list.js +1 -1
- package/src/commands/integration/update.js +1 -1
- package/src/commands/project/api/add.js +2 -2
- package/src/commands/project/api/remove.js +3 -3
- package/src/commands/project/create.js +4 -4
- package/src/commands/project/delete.js +2 -2
- package/src/commands/project/domain/add.js +2 -2
- package/src/commands/project/domain/remove.js +3 -3
- package/src/commands/project/get.js +1 -1
- package/src/commands/project/list.js +1 -1
- package/src/commands/project/member/list.js +2 -2
- package/src/commands/spectral/download.js +1 -1
- package/src/commands/spectral/upload.js +1 -1
- package/src/support/command/base-command.js +1 -1
- package/src/support/inquirer/prompt-templates.js +1 -1
- package/src/support/isOnPrem.js +2 -2
- package/src/template-strings/errors.js +4 -4
- package/src/template-strings/info.js +8 -2
package/oclif.manifest.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"configure": {
|
|
4
4
|
"aliases": [],
|
|
5
5
|
"args": {},
|
|
6
|
-
"description": "configure application settings\nEnter the
|
|
6
|
+
"description": "configure application settings\nEnter the Swagger URL - default is https://api.swaggerhub.com\nCustomers with on-premise installations (version 2.x) need to point this to their on-premise API, which is http(s)://{swaggerhub-host}/v1\nEnter the API Key - this can be retrieved from https://app.swaggerhub.com/settings/apiKey\nYou can set these as environment variables: SWAGGERHUB_URL, SWAGGERHUB_API_KEY. These take priority over config settings.\n",
|
|
7
7
|
"flags": {
|
|
8
8
|
"help": {
|
|
9
9
|
"char": "h",
|
|
@@ -28,11 +28,66 @@
|
|
|
28
28
|
"configure.js"
|
|
29
29
|
]
|
|
30
30
|
},
|
|
31
|
+
"api:clone": {
|
|
32
|
+
"aliases": [],
|
|
33
|
+
"args": {
|
|
34
|
+
"OWNER/API_NAME/VERSION": {
|
|
35
|
+
"description": "API version to clone",
|
|
36
|
+
"name": "OWNER/API_NAME/VERSION",
|
|
37
|
+
"required": true
|
|
38
|
+
},
|
|
39
|
+
"NEW_VERSION": {
|
|
40
|
+
"description": "Version identifier of the new API version",
|
|
41
|
+
"name": "NEW_VERSION",
|
|
42
|
+
"required": true
|
|
43
|
+
}
|
|
44
|
+
},
|
|
45
|
+
"description": "clone an API version as a new version",
|
|
46
|
+
"examples": [
|
|
47
|
+
"swaggerhub api:clone organization/api/1.0.0 1.0.1",
|
|
48
|
+
"swaggerhub api:clone organization/api/1.0.0 1.0.1 --visibility public"
|
|
49
|
+
],
|
|
50
|
+
"flags": {
|
|
51
|
+
"visibility": {
|
|
52
|
+
"description": "visibility of the new version (defaults to the server setting)",
|
|
53
|
+
"name": "visibility",
|
|
54
|
+
"hasDynamicHelp": false,
|
|
55
|
+
"multiple": false,
|
|
56
|
+
"options": [
|
|
57
|
+
"public",
|
|
58
|
+
"private"
|
|
59
|
+
],
|
|
60
|
+
"type": "option"
|
|
61
|
+
},
|
|
62
|
+
"help": {
|
|
63
|
+
"char": "h",
|
|
64
|
+
"description": "Show CLI help.",
|
|
65
|
+
"name": "help",
|
|
66
|
+
"allowNo": false,
|
|
67
|
+
"type": "boolean"
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
"hasDynamicHelp": false,
|
|
71
|
+
"hiddenAliases": [],
|
|
72
|
+
"id": "api:clone",
|
|
73
|
+
"pluginAlias": "swaggerhub-cli",
|
|
74
|
+
"pluginName": "swaggerhub-cli",
|
|
75
|
+
"pluginType": "core",
|
|
76
|
+
"strict": true,
|
|
77
|
+
"enableJsonFlag": false,
|
|
78
|
+
"isESM": false,
|
|
79
|
+
"relativePath": [
|
|
80
|
+
"src",
|
|
81
|
+
"commands",
|
|
82
|
+
"api",
|
|
83
|
+
"clone.js"
|
|
84
|
+
]
|
|
85
|
+
},
|
|
31
86
|
"api:create": {
|
|
32
87
|
"aliases": [],
|
|
33
88
|
"args": {
|
|
34
89
|
"OWNER/API_NAME/[VERSION]": {
|
|
35
|
-
"description": "API to create on
|
|
90
|
+
"description": "API to create on Swagger",
|
|
36
91
|
"name": "OWNER/API_NAME/[VERSION]",
|
|
37
92
|
"required": true
|
|
38
93
|
}
|
|
@@ -56,7 +111,7 @@
|
|
|
56
111
|
"type": "option"
|
|
57
112
|
},
|
|
58
113
|
"visibility": {
|
|
59
|
-
"description": "visibility of API in
|
|
114
|
+
"description": "visibility of API in Swagger",
|
|
60
115
|
"name": "visibility",
|
|
61
116
|
"default": "private",
|
|
62
117
|
"hasDynamicHelp": false,
|
|
@@ -120,7 +175,7 @@
|
|
|
120
175
|
"aliases": [],
|
|
121
176
|
"args": {
|
|
122
177
|
"OWNER/API_NAME/[VERSION]": {
|
|
123
|
-
"description": "API to delete on
|
|
178
|
+
"description": "API to delete on Swagger",
|
|
124
179
|
"name": "OWNER/API_NAME/[VERSION]",
|
|
125
180
|
"required": true
|
|
126
181
|
}
|
|
@@ -167,7 +222,7 @@
|
|
|
167
222
|
"aliases": [],
|
|
168
223
|
"args": {
|
|
169
224
|
"OWNER/API_NAME/[VERSION]": {
|
|
170
|
-
"description": "API to fetch from
|
|
225
|
+
"description": "API to fetch from Swagger",
|
|
171
226
|
"name": "OWNER/API_NAME/[VERSION]",
|
|
172
227
|
"required": true
|
|
173
228
|
}
|
|
@@ -187,7 +242,7 @@
|
|
|
187
242
|
},
|
|
188
243
|
"resolved": {
|
|
189
244
|
"char": "r",
|
|
190
|
-
"description": "gets the resolved API definition
|
|
245
|
+
"description": "gets the resolved API definition",
|
|
191
246
|
"name": "resolved",
|
|
192
247
|
"allowNo": false,
|
|
193
248
|
"type": "boolean"
|
|
@@ -220,7 +275,7 @@
|
|
|
220
275
|
"aliases": [],
|
|
221
276
|
"args": {
|
|
222
277
|
"OWNER/API_NAME/VERSION": {
|
|
223
|
-
"description": "API to publish on
|
|
278
|
+
"description": "API to publish on Swagger",
|
|
224
279
|
"name": "OWNER/API_NAME/VERSION",
|
|
225
280
|
"required": true
|
|
226
281
|
}
|
|
@@ -308,7 +363,7 @@
|
|
|
308
363
|
"aliases": [],
|
|
309
364
|
"args": {
|
|
310
365
|
"OWNER/API_NAME/VERSION": {
|
|
311
|
-
"description": "API to set as default on
|
|
366
|
+
"description": "API to set as default on Swagger",
|
|
312
367
|
"name": "OWNER/API_NAME/VERSION",
|
|
313
368
|
"required": true
|
|
314
369
|
}
|
|
@@ -382,12 +437,12 @@
|
|
|
382
437
|
"aliases": [],
|
|
383
438
|
"args": {
|
|
384
439
|
"OWNER/API_NAME/[VERSION]": {
|
|
385
|
-
"description": "API to update on
|
|
440
|
+
"description": "API to update on Swagger",
|
|
386
441
|
"name": "OWNER/API_NAME/[VERSION]",
|
|
387
442
|
"required": true
|
|
388
443
|
}
|
|
389
444
|
},
|
|
390
|
-
"description": "update an API\nThe API version from the file will be used unless the version is specified in the command argument.\nWhen no file is specified then the default API version will be updated.\nThe API visibility can be changed by using visibility flag.\n",
|
|
445
|
+
"description": "update an API\nThe API version from the file will be used unless the version is specified in the command argument.\nWhen no file is specified then the default API version will be updated.\nThe API visibility can be changed by using the --visibility flag.\n",
|
|
391
446
|
"examples": [
|
|
392
447
|
"swaggerhub api:update organization/api --file api.yaml",
|
|
393
448
|
"swaggerhub api:update organization/api/1.0.0 --file api.json",
|
|
@@ -407,7 +462,7 @@
|
|
|
407
462
|
"type": "option"
|
|
408
463
|
},
|
|
409
464
|
"visibility": {
|
|
410
|
-
"description": "visibility of API in
|
|
465
|
+
"description": "visibility of API in Swagger",
|
|
411
466
|
"name": "visibility",
|
|
412
467
|
"hasDynamicHelp": false,
|
|
413
468
|
"multiple": false,
|
|
@@ -459,11 +514,66 @@
|
|
|
459
514
|
"update.js"
|
|
460
515
|
]
|
|
461
516
|
},
|
|
517
|
+
"domain:clone": {
|
|
518
|
+
"aliases": [],
|
|
519
|
+
"args": {
|
|
520
|
+
"OWNER/DOMAIN_NAME/VERSION": {
|
|
521
|
+
"description": "Domain version to clone",
|
|
522
|
+
"name": "OWNER/DOMAIN_NAME/VERSION",
|
|
523
|
+
"required": true
|
|
524
|
+
},
|
|
525
|
+
"NEW_VERSION": {
|
|
526
|
+
"description": "Version identifier of the new domain version",
|
|
527
|
+
"name": "NEW_VERSION",
|
|
528
|
+
"required": true
|
|
529
|
+
}
|
|
530
|
+
},
|
|
531
|
+
"description": "clone a domain version as a new version",
|
|
532
|
+
"examples": [
|
|
533
|
+
"swaggerhub domain:clone organization/domain/1.0.0 1.0.1",
|
|
534
|
+
"swaggerhub domain:clone organization/domain/1.0.0 1.0.1 --visibility public"
|
|
535
|
+
],
|
|
536
|
+
"flags": {
|
|
537
|
+
"visibility": {
|
|
538
|
+
"description": "visibility of the new version (defaults to the server setting)",
|
|
539
|
+
"name": "visibility",
|
|
540
|
+
"hasDynamicHelp": false,
|
|
541
|
+
"multiple": false,
|
|
542
|
+
"options": [
|
|
543
|
+
"public",
|
|
544
|
+
"private"
|
|
545
|
+
],
|
|
546
|
+
"type": "option"
|
|
547
|
+
},
|
|
548
|
+
"help": {
|
|
549
|
+
"char": "h",
|
|
550
|
+
"description": "Show CLI help.",
|
|
551
|
+
"name": "help",
|
|
552
|
+
"allowNo": false,
|
|
553
|
+
"type": "boolean"
|
|
554
|
+
}
|
|
555
|
+
},
|
|
556
|
+
"hasDynamicHelp": false,
|
|
557
|
+
"hiddenAliases": [],
|
|
558
|
+
"id": "domain:clone",
|
|
559
|
+
"pluginAlias": "swaggerhub-cli",
|
|
560
|
+
"pluginName": "swaggerhub-cli",
|
|
561
|
+
"pluginType": "core",
|
|
562
|
+
"strict": true,
|
|
563
|
+
"enableJsonFlag": false,
|
|
564
|
+
"isESM": false,
|
|
565
|
+
"relativePath": [
|
|
566
|
+
"src",
|
|
567
|
+
"commands",
|
|
568
|
+
"domain",
|
|
569
|
+
"clone.js"
|
|
570
|
+
]
|
|
571
|
+
},
|
|
462
572
|
"domain:create": {
|
|
463
573
|
"aliases": [],
|
|
464
574
|
"args": {
|
|
465
575
|
"OWNER/DOMAIN_NAME/[VERSION]": {
|
|
466
|
-
"description": "Domain to create on
|
|
576
|
+
"description": "Domain to create on Swagger",
|
|
467
577
|
"name": "OWNER/DOMAIN_NAME/[VERSION]",
|
|
468
578
|
"required": true
|
|
469
579
|
}
|
|
@@ -472,9 +582,9 @@
|
|
|
472
582
|
"examples": [
|
|
473
583
|
"swaggerhub domain:create organization/domain/1.0.0 --file domain.yaml --visibility public",
|
|
474
584
|
"swaggerhub domain:create organization/domain --file domain.yaml",
|
|
475
|
-
"swaggerhub domain:create organization/domain/1.0.0 --publish --file domain.json",
|
|
585
|
+
"swaggerhub domain:create organization/domain/1.0.0 --published=publish --file domain.json",
|
|
476
586
|
"swaggerhub domain:create organization/domain/1.0.0 --setdefault --file domain.json",
|
|
477
|
-
"swaggerhub domain:create organization/domain/1.0.0 --publish --setdefault --file domain.json"
|
|
587
|
+
"swaggerhub domain:create organization/domain/1.0.0 --published=publish --setdefault --file domain.json"
|
|
478
588
|
],
|
|
479
589
|
"flags": {
|
|
480
590
|
"file": {
|
|
@@ -487,7 +597,7 @@
|
|
|
487
597
|
"type": "option"
|
|
488
598
|
},
|
|
489
599
|
"visibility": {
|
|
490
|
-
"description": "visibility of domain in
|
|
600
|
+
"description": "visibility of domain in Swagger",
|
|
491
601
|
"name": "visibility",
|
|
492
602
|
"default": "private",
|
|
493
603
|
"hasDynamicHelp": false,
|
|
@@ -551,7 +661,7 @@
|
|
|
551
661
|
"aliases": [],
|
|
552
662
|
"args": {
|
|
553
663
|
"OWNER/DOMAIN_NAME/[VERSION]": {
|
|
554
|
-
"description": "Domain to delete on
|
|
664
|
+
"description": "Domain to delete on Swagger",
|
|
555
665
|
"name": "OWNER/DOMAIN_NAME/[VERSION]",
|
|
556
666
|
"required": true
|
|
557
667
|
}
|
|
@@ -598,7 +708,7 @@
|
|
|
598
708
|
"aliases": [],
|
|
599
709
|
"args": {
|
|
600
710
|
"OWNER/DOMAIN_NAME/[VERSION]": {
|
|
601
|
-
"description": "Domain to fetch from
|
|
711
|
+
"description": "Domain to fetch from Swagger",
|
|
602
712
|
"name": "OWNER/DOMAIN_NAME/[VERSION]",
|
|
603
713
|
"required": true
|
|
604
714
|
}
|
|
@@ -644,7 +754,7 @@
|
|
|
644
754
|
"aliases": [],
|
|
645
755
|
"args": {
|
|
646
756
|
"OWNER/DOMAIN_NAME/VERSION": {
|
|
647
|
-
"description": "Domain to publish on
|
|
757
|
+
"description": "Domain to publish on Swagger",
|
|
648
758
|
"name": "OWNER/DOMAIN_NAME/VERSION",
|
|
649
759
|
"required": true
|
|
650
760
|
}
|
|
@@ -685,11 +795,62 @@
|
|
|
685
795
|
"publish.js"
|
|
686
796
|
]
|
|
687
797
|
},
|
|
798
|
+
"domain:rename": {
|
|
799
|
+
"aliases": [],
|
|
800
|
+
"args": {
|
|
801
|
+
"OWNER/DOMAIN_NAME": {
|
|
802
|
+
"description": "Domain to be renamed",
|
|
803
|
+
"name": "OWNER/DOMAIN_NAME",
|
|
804
|
+
"required": true
|
|
805
|
+
},
|
|
806
|
+
"DOMAIN_NEW_NAME": {
|
|
807
|
+
"description": "New name for the domain",
|
|
808
|
+
"name": "DOMAIN_NEW_NAME",
|
|
809
|
+
"required": true
|
|
810
|
+
}
|
|
811
|
+
},
|
|
812
|
+
"description": "rename a domain",
|
|
813
|
+
"examples": [
|
|
814
|
+
"swaggerhub domain:rename organization/domainOldName domainNewName",
|
|
815
|
+
"swaggerhub domain:rename organization/domainOldName domainNewName --force"
|
|
816
|
+
],
|
|
817
|
+
"flags": {
|
|
818
|
+
"force": {
|
|
819
|
+
"char": "f",
|
|
820
|
+
"description": "rename the domain even if it is referenced by APIs or other domains",
|
|
821
|
+
"name": "force",
|
|
822
|
+
"allowNo": false,
|
|
823
|
+
"type": "boolean"
|
|
824
|
+
},
|
|
825
|
+
"help": {
|
|
826
|
+
"char": "h",
|
|
827
|
+
"description": "Show CLI help.",
|
|
828
|
+
"name": "help",
|
|
829
|
+
"allowNo": false,
|
|
830
|
+
"type": "boolean"
|
|
831
|
+
}
|
|
832
|
+
},
|
|
833
|
+
"hasDynamicHelp": false,
|
|
834
|
+
"hiddenAliases": [],
|
|
835
|
+
"id": "domain:rename",
|
|
836
|
+
"pluginAlias": "swaggerhub-cli",
|
|
837
|
+
"pluginName": "swaggerhub-cli",
|
|
838
|
+
"pluginType": "core",
|
|
839
|
+
"strict": true,
|
|
840
|
+
"enableJsonFlag": false,
|
|
841
|
+
"isESM": false,
|
|
842
|
+
"relativePath": [
|
|
843
|
+
"src",
|
|
844
|
+
"commands",
|
|
845
|
+
"domain",
|
|
846
|
+
"rename.js"
|
|
847
|
+
]
|
|
848
|
+
},
|
|
688
849
|
"domain:setdefault": {
|
|
689
850
|
"aliases": [],
|
|
690
851
|
"args": {
|
|
691
852
|
"OWNER/DOMAIN_NAME/VERSION": {
|
|
692
|
-
"description": "Domain to set as default on
|
|
853
|
+
"description": "Domain to set as default on Swagger",
|
|
693
854
|
"name": "OWNER/DOMAIN_NAME/VERSION",
|
|
694
855
|
"required": true
|
|
695
856
|
}
|
|
@@ -726,7 +887,7 @@
|
|
|
726
887
|
"aliases": [],
|
|
727
888
|
"args": {
|
|
728
889
|
"OWNER/DOMAIN_NAME/VERSION": {
|
|
729
|
-
"description": "Domain to unpublish on
|
|
890
|
+
"description": "Domain to unpublish on Swagger",
|
|
730
891
|
"name": "OWNER/DOMAIN_NAME/VERSION",
|
|
731
892
|
"required": true
|
|
732
893
|
}
|
|
@@ -763,12 +924,12 @@
|
|
|
763
924
|
"aliases": [],
|
|
764
925
|
"args": {
|
|
765
926
|
"OWNER/DOMAIN_NAME/[VERSION]": {
|
|
766
|
-
"description": "Domain to update on
|
|
927
|
+
"description": "Domain to update on Swagger",
|
|
767
928
|
"name": "OWNER/DOMAIN_NAME/[VERSION]",
|
|
768
929
|
"required": true
|
|
769
930
|
}
|
|
770
931
|
},
|
|
771
|
-
"description": "update a domain\nThe domain version from the file will be used unless the version is specified in the command argument.\nWhen no file is specified then the default domain version will be updated.\nThe domain visibility can be changed by using visibility flag.\n",
|
|
932
|
+
"description": "update a domain\nThe domain version from the file will be used unless the version is specified in the command argument.\nWhen no file is specified then the default domain version will be updated.\nThe domain visibility can be changed by using the --visibility flag.\n",
|
|
772
933
|
"examples": [
|
|
773
934
|
"swaggerhub domain:update organization/domain --file domain.yaml",
|
|
774
935
|
"swaggerhub domain:update organization/domain/1.0.0 --file domain.json",
|
|
@@ -788,7 +949,7 @@
|
|
|
788
949
|
"type": "option"
|
|
789
950
|
},
|
|
790
951
|
"visibility": {
|
|
791
|
-
"description": "visibility of domain in
|
|
952
|
+
"description": "visibility of domain in Swagger",
|
|
792
953
|
"name": "visibility",
|
|
793
954
|
"hasDynamicHelp": false,
|
|
794
955
|
"multiple": false,
|
|
@@ -844,12 +1005,12 @@
|
|
|
844
1005
|
"aliases": [],
|
|
845
1006
|
"args": {
|
|
846
1007
|
"OWNER/API_NAME/[VERSION]": {
|
|
847
|
-
"description": "API to add integration to on
|
|
1008
|
+
"description": "API to add integration to on Swagger",
|
|
848
1009
|
"name": "OWNER/API_NAME/[VERSION]",
|
|
849
1010
|
"required": true
|
|
850
1011
|
}
|
|
851
1012
|
},
|
|
852
|
-
"description": "creates a new API integration from a JSON configuration file.\nSee the documentation for configuration files: https://github.com/SmartBear/swaggerhub-cli/tree/main/examples/integrations\nWhen VERSION is not included in the argument, the integration will be added to
|
|
1013
|
+
"description": "creates a new API integration from a JSON configuration file.\nSee the documentation for configuration files: https://github.com/SmartBear/swaggerhub-cli/tree/main/examples/integrations\nWhen VERSION is not included in the argument, the integration will be added to the default API version.\n",
|
|
853
1014
|
"examples": [
|
|
854
1015
|
"swaggerhub integration:create organization/api/1.0.0 --file config.json"
|
|
855
1016
|
],
|
|
@@ -891,7 +1052,7 @@
|
|
|
891
1052
|
"aliases": [],
|
|
892
1053
|
"args": {
|
|
893
1054
|
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
894
|
-
"description": "Integration to delete for given API on
|
|
1055
|
+
"description": "Integration to delete for given API on Swagger",
|
|
895
1056
|
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
896
1057
|
"required": true
|
|
897
1058
|
}
|
|
@@ -929,7 +1090,7 @@
|
|
|
929
1090
|
"aliases": [],
|
|
930
1091
|
"args": {
|
|
931
1092
|
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
932
|
-
"description": "Integration to execute for given API on
|
|
1093
|
+
"description": "Integration to execute for given API on Swagger",
|
|
933
1094
|
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
934
1095
|
"required": true
|
|
935
1096
|
}
|
|
@@ -967,12 +1128,12 @@
|
|
|
967
1128
|
"aliases": [],
|
|
968
1129
|
"args": {
|
|
969
1130
|
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
970
|
-
"description": "Integration to fetch for given API on
|
|
1131
|
+
"description": "Integration to fetch for given API on Swagger",
|
|
971
1132
|
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
972
1133
|
"required": true
|
|
973
1134
|
}
|
|
974
1135
|
},
|
|
975
|
-
"description": "
|
|
1136
|
+
"description": "retrieves an integration for the given API.",
|
|
976
1137
|
"examples": [
|
|
977
1138
|
"swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704"
|
|
978
1139
|
],
|
|
@@ -1005,7 +1166,7 @@
|
|
|
1005
1166
|
"aliases": [],
|
|
1006
1167
|
"args": {
|
|
1007
1168
|
"OWNER/API_NAME/[VERSION]": {
|
|
1008
|
-
"description": "API to list integrations for
|
|
1169
|
+
"description": "API to list integrations for",
|
|
1009
1170
|
"name": "OWNER/API_NAME/[VERSION]",
|
|
1010
1171
|
"required": true
|
|
1011
1172
|
}
|
|
@@ -1043,7 +1204,7 @@
|
|
|
1043
1204
|
"aliases": [],
|
|
1044
1205
|
"args": {
|
|
1045
1206
|
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
1046
|
-
"description": "Integration to update for given API on
|
|
1207
|
+
"description": "Integration to update for given API on Swagger",
|
|
1047
1208
|
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
1048
1209
|
"required": true
|
|
1049
1210
|
}
|
|
@@ -1090,12 +1251,12 @@
|
|
|
1090
1251
|
"aliases": [],
|
|
1091
1252
|
"args": {
|
|
1092
1253
|
"OWNER/PROJECT_NAME": {
|
|
1093
|
-
"description": "The new project to create on
|
|
1254
|
+
"description": "The new project to create on Swagger",
|
|
1094
1255
|
"name": "OWNER/PROJECT_NAME",
|
|
1095
1256
|
"required": true
|
|
1096
1257
|
}
|
|
1097
1258
|
},
|
|
1098
|
-
"description": "Creates a new project in
|
|
1259
|
+
"description": "Creates a new project in Swagger.",
|
|
1099
1260
|
"examples": [
|
|
1100
1261
|
"swaggerhub project:create organization/new_project_name --description \"project description\"",
|
|
1101
1262
|
"swaggerhub project:create organization/new_project_name -a \"testapi1,testapi2\"",
|
|
@@ -1115,7 +1276,7 @@
|
|
|
1115
1276
|
},
|
|
1116
1277
|
"apis": {
|
|
1117
1278
|
"char": "a",
|
|
1118
|
-
"description": "Comma
|
|
1279
|
+
"description": "Comma-separated list of API names to include in project",
|
|
1119
1280
|
"name": "apis",
|
|
1120
1281
|
"required": false,
|
|
1121
1282
|
"hasDynamicHelp": false,
|
|
@@ -1124,7 +1285,7 @@
|
|
|
1124
1285
|
},
|
|
1125
1286
|
"domains": {
|
|
1126
1287
|
"char": "d",
|
|
1127
|
-
"description": "Comma
|
|
1288
|
+
"description": "Comma-separated list of domain names to include in project",
|
|
1128
1289
|
"name": "domains",
|
|
1129
1290
|
"required": false,
|
|
1130
1291
|
"hasDynamicHelp": false,
|
|
@@ -1159,12 +1320,12 @@
|
|
|
1159
1320
|
"aliases": [],
|
|
1160
1321
|
"args": {
|
|
1161
1322
|
"OWNER/PROJECT_NAME": {
|
|
1162
|
-
"description": "The project to delete on
|
|
1323
|
+
"description": "The project to delete on Swagger",
|
|
1163
1324
|
"name": "OWNER/PROJECT_NAME",
|
|
1164
1325
|
"required": true
|
|
1165
1326
|
}
|
|
1166
1327
|
},
|
|
1167
|
-
"description": "Deletes a project from
|
|
1328
|
+
"description": "Deletes a project from Swagger.",
|
|
1168
1329
|
"examples": [
|
|
1169
1330
|
"swaggerhub project:delete organization/project_name"
|
|
1170
1331
|
],
|
|
@@ -1197,7 +1358,7 @@
|
|
|
1197
1358
|
"aliases": [],
|
|
1198
1359
|
"args": {
|
|
1199
1360
|
"OWNER/PROJECT_NAME": {
|
|
1200
|
-
"description": "The project to get details for on
|
|
1361
|
+
"description": "The project to get details for on Swagger",
|
|
1201
1362
|
"name": "OWNER/PROJECT_NAME",
|
|
1202
1363
|
"required": true
|
|
1203
1364
|
}
|
|
@@ -1235,7 +1396,7 @@
|
|
|
1235
1396
|
"aliases": [],
|
|
1236
1397
|
"args": {
|
|
1237
1398
|
"OWNER": {
|
|
1238
|
-
"description": "The organization to list projects for on
|
|
1399
|
+
"description": "The organization to list projects for on Swagger",
|
|
1239
1400
|
"name": "OWNER",
|
|
1240
1401
|
"required": false
|
|
1241
1402
|
}
|
|
@@ -1302,7 +1463,7 @@
|
|
|
1302
1463
|
"aliases": [],
|
|
1303
1464
|
"args": {
|
|
1304
1465
|
"OWNER/RULESET_NAME": {
|
|
1305
|
-
"description": "Organization's Spectral ruleset to create or update on
|
|
1466
|
+
"description": "Organization's Spectral ruleset to create or update on Swagger",
|
|
1306
1467
|
"name": "OWNER/RULESET_NAME",
|
|
1307
1468
|
"required": true
|
|
1308
1469
|
},
|
|
@@ -1345,7 +1506,7 @@
|
|
|
1345
1506
|
"aliases": [],
|
|
1346
1507
|
"args": {
|
|
1347
1508
|
"OWNER/RULESET_NAME": {
|
|
1348
|
-
"description": "Organization's Spectral ruleset to create or update on
|
|
1509
|
+
"description": "Organization's Spectral ruleset to create or update on Swagger",
|
|
1349
1510
|
"name": "OWNER/RULESET_NAME",
|
|
1350
1511
|
"required": true
|
|
1351
1512
|
},
|
|
@@ -1388,12 +1549,12 @@
|
|
|
1388
1549
|
"aliases": [],
|
|
1389
1550
|
"args": {
|
|
1390
1551
|
"OWNER": {
|
|
1391
|
-
"description": "Which organization standardization rules to fetch from
|
|
1552
|
+
"description": "Which organization standardization rules to fetch from Swagger",
|
|
1392
1553
|
"name": "OWNER",
|
|
1393
1554
|
"required": true
|
|
1394
1555
|
}
|
|
1395
1556
|
},
|
|
1396
|
-
"description": "Get
|
|
1557
|
+
"description": "Get an organization's existing standardization ruleset from Swagger.\nRequires organization name argument. An error will occur if the provided organization doesn't exist\nor your account is not permitted to access that organization's settings.\nIf the flag `-s` or `--include-system-rules` is used, the returned ruleset will also include Swagger system rules.\nIf the flag `-d` or `--include-disabled-rules` is used, the returned ruleset will also include disabled custom rules.",
|
|
1397
1558
|
"examples": [
|
|
1398
1559
|
"swaggerhub api:validate:download-rules myOrg -s",
|
|
1399
1560
|
"swaggerhub api:validate:download-rules myOrg --include-disabled-rules -s"
|
|
@@ -1444,12 +1605,12 @@
|
|
|
1444
1605
|
"aliases": [],
|
|
1445
1606
|
"args": {
|
|
1446
1607
|
"OWNER/API_NAME/[VERSION]": {
|
|
1447
|
-
"description": "API to fetch validation errors for
|
|
1608
|
+
"description": "API to fetch validation errors for",
|
|
1448
1609
|
"name": "OWNER/API_NAME/[VERSION]",
|
|
1449
1610
|
"required": true
|
|
1450
1611
|
}
|
|
1451
1612
|
},
|
|
1452
|
-
"description": "Get validation result for an API version\nWhen VERSION is not included in the argument, the default version will be validated.\nAn error will occur if the API version does not exist.\nIf the flag `-c` or `--
|
|
1613
|
+
"description": "Get validation result for an API version\nWhen VERSION is not included in the argument, the default version will be validated.\nAn error will occur if the API version does not exist.\nIf the flag `-c` or `--fail-on-critical` is used and there are standardization\nerrors with `Critical` severity present, the command will exit with error code `1`.\n",
|
|
1453
1614
|
"examples": [
|
|
1454
1615
|
"swaggerhub api:validate organization/api/1.0.0",
|
|
1455
1616
|
"swaggerhub api:validate -c -j organization/api/1.0.0",
|
|
@@ -1498,10 +1659,10 @@
|
|
|
1498
1659
|
"api:validate:local": {
|
|
1499
1660
|
"aliases": [],
|
|
1500
1661
|
"args": {},
|
|
1501
|
-
"description": "Runs a scan against a local API definition using the organization's standardization configuration on
|
|
1662
|
+
"description": "Runs a scan against a local API definition using the organization's standardization configuration on Swagger.\nIf the flag `-c` or `--fail-on-critical` is used and there are standardization\nerrors with `Critical` severity present, the command will exit with error code `1`.\n",
|
|
1502
1663
|
"examples": [
|
|
1503
1664
|
"swaggerhub api:validate:local -o myOrg -f ./my-api.yaml -c -j ",
|
|
1504
|
-
"swaggerhub api:validate:local --organization myOrg --file ./my-api
|
|
1665
|
+
"swaggerhub api:validate:local --organization myOrg --file ./my-api.json --fail-on-critical --json"
|
|
1505
1666
|
],
|
|
1506
1667
|
"flags": {
|
|
1507
1668
|
"file": {
|
|
@@ -1561,23 +1722,23 @@
|
|
|
1561
1722
|
"local.js"
|
|
1562
1723
|
]
|
|
1563
1724
|
},
|
|
1564
|
-
"project:
|
|
1725
|
+
"project:api:add": {
|
|
1565
1726
|
"aliases": [],
|
|
1566
1727
|
"args": {
|
|
1567
1728
|
"OWNER/PROJECT_NAME": {
|
|
1568
|
-
"description": "The project to add the
|
|
1729
|
+
"description": "The project to add the API to on Swagger",
|
|
1569
1730
|
"name": "OWNER/PROJECT_NAME",
|
|
1570
1731
|
"required": true
|
|
1571
1732
|
},
|
|
1572
|
-
"
|
|
1573
|
-
"description": "The name of the
|
|
1574
|
-
"name": "
|
|
1733
|
+
"API": {
|
|
1734
|
+
"description": "The name of the API on Swagger to add",
|
|
1735
|
+
"name": "API",
|
|
1575
1736
|
"required": true
|
|
1576
1737
|
}
|
|
1577
1738
|
},
|
|
1578
|
-
"description": "Adds
|
|
1739
|
+
"description": "Adds an API to an existing project.",
|
|
1579
1740
|
"examples": [
|
|
1580
|
-
"swaggerhub project:
|
|
1741
|
+
"swaggerhub project:api:add organization/project_name my_api"
|
|
1581
1742
|
],
|
|
1582
1743
|
"flags": {
|
|
1583
1744
|
"help": {
|
|
@@ -1590,7 +1751,7 @@
|
|
|
1590
1751
|
},
|
|
1591
1752
|
"hasDynamicHelp": false,
|
|
1592
1753
|
"hiddenAliases": [],
|
|
1593
|
-
"id": "project:
|
|
1754
|
+
"id": "project:api:add",
|
|
1594
1755
|
"pluginAlias": "swaggerhub-cli",
|
|
1595
1756
|
"pluginName": "swaggerhub-cli",
|
|
1596
1757
|
"pluginType": "core",
|
|
@@ -1601,27 +1762,27 @@
|
|
|
1601
1762
|
"src",
|
|
1602
1763
|
"commands",
|
|
1603
1764
|
"project",
|
|
1604
|
-
"
|
|
1765
|
+
"api",
|
|
1605
1766
|
"add.js"
|
|
1606
1767
|
]
|
|
1607
1768
|
},
|
|
1608
|
-
"project:
|
|
1769
|
+
"project:api:remove": {
|
|
1609
1770
|
"aliases": [],
|
|
1610
1771
|
"args": {
|
|
1611
1772
|
"OWNER/PROJECT_NAME": {
|
|
1612
|
-
"description": "The project to remove the
|
|
1773
|
+
"description": "The project to remove the API from on Swagger",
|
|
1613
1774
|
"name": "OWNER/PROJECT_NAME",
|
|
1614
1775
|
"required": true
|
|
1615
1776
|
},
|
|
1616
|
-
"
|
|
1617
|
-
"description": "The name of the
|
|
1618
|
-
"name": "
|
|
1777
|
+
"API": {
|
|
1778
|
+
"description": "The name of the API on Swagger to remove",
|
|
1779
|
+
"name": "API",
|
|
1619
1780
|
"required": true
|
|
1620
1781
|
}
|
|
1621
1782
|
},
|
|
1622
|
-
"description": "Removes
|
|
1783
|
+
"description": "Removes an API from a project in Swagger.",
|
|
1623
1784
|
"examples": [
|
|
1624
|
-
"swaggerhub project:
|
|
1785
|
+
"swaggerhub project:api:remove organization/project_name my_api"
|
|
1625
1786
|
],
|
|
1626
1787
|
"flags": {
|
|
1627
1788
|
"help": {
|
|
@@ -1634,7 +1795,7 @@
|
|
|
1634
1795
|
},
|
|
1635
1796
|
"hasDynamicHelp": false,
|
|
1636
1797
|
"hiddenAliases": [],
|
|
1637
|
-
"id": "project:
|
|
1798
|
+
"id": "project:api:remove",
|
|
1638
1799
|
"pluginAlias": "swaggerhub-cli",
|
|
1639
1800
|
"pluginName": "swaggerhub-cli",
|
|
1640
1801
|
"pluginType": "core",
|
|
@@ -1645,27 +1806,27 @@
|
|
|
1645
1806
|
"src",
|
|
1646
1807
|
"commands",
|
|
1647
1808
|
"project",
|
|
1648
|
-
"
|
|
1809
|
+
"api",
|
|
1649
1810
|
"remove.js"
|
|
1650
1811
|
]
|
|
1651
1812
|
},
|
|
1652
|
-
"project:
|
|
1813
|
+
"project:domain:add": {
|
|
1653
1814
|
"aliases": [],
|
|
1654
1815
|
"args": {
|
|
1655
1816
|
"OWNER/PROJECT_NAME": {
|
|
1656
|
-
"description": "The project to add the
|
|
1817
|
+
"description": "The project to add the domain to on Swagger",
|
|
1657
1818
|
"name": "OWNER/PROJECT_NAME",
|
|
1658
1819
|
"required": true
|
|
1659
1820
|
},
|
|
1660
|
-
"
|
|
1661
|
-
"description": "The name of the
|
|
1662
|
-
"name": "
|
|
1821
|
+
"DOMAIN": {
|
|
1822
|
+
"description": "The name of the domain on Swagger to add",
|
|
1823
|
+
"name": "DOMAIN",
|
|
1663
1824
|
"required": true
|
|
1664
1825
|
}
|
|
1665
1826
|
},
|
|
1666
|
-
"description": "Adds
|
|
1827
|
+
"description": "Adds a domain to an existing project.",
|
|
1667
1828
|
"examples": [
|
|
1668
|
-
"swaggerhub project:
|
|
1829
|
+
"swaggerhub project:domain:add organization/project_name my_domain"
|
|
1669
1830
|
],
|
|
1670
1831
|
"flags": {
|
|
1671
1832
|
"help": {
|
|
@@ -1678,7 +1839,7 @@
|
|
|
1678
1839
|
},
|
|
1679
1840
|
"hasDynamicHelp": false,
|
|
1680
1841
|
"hiddenAliases": [],
|
|
1681
|
-
"id": "project:
|
|
1842
|
+
"id": "project:domain:add",
|
|
1682
1843
|
"pluginAlias": "swaggerhub-cli",
|
|
1683
1844
|
"pluginName": "swaggerhub-cli",
|
|
1684
1845
|
"pluginType": "core",
|
|
@@ -1689,27 +1850,27 @@
|
|
|
1689
1850
|
"src",
|
|
1690
1851
|
"commands",
|
|
1691
1852
|
"project",
|
|
1692
|
-
"
|
|
1853
|
+
"domain",
|
|
1693
1854
|
"add.js"
|
|
1694
1855
|
]
|
|
1695
1856
|
},
|
|
1696
|
-
"project:
|
|
1857
|
+
"project:domain:remove": {
|
|
1697
1858
|
"aliases": [],
|
|
1698
1859
|
"args": {
|
|
1699
1860
|
"OWNER/PROJECT_NAME": {
|
|
1700
|
-
"description": "The project to remove the
|
|
1861
|
+
"description": "The project to remove the domain from on Swagger",
|
|
1701
1862
|
"name": "OWNER/PROJECT_NAME",
|
|
1702
1863
|
"required": true
|
|
1703
1864
|
},
|
|
1704
|
-
"
|
|
1705
|
-
"description": "The name of the
|
|
1706
|
-
"name": "
|
|
1865
|
+
"DOMAIN": {
|
|
1866
|
+
"description": "The name of the domain on Swagger to remove",
|
|
1867
|
+
"name": "DOMAIN",
|
|
1707
1868
|
"required": true
|
|
1708
1869
|
}
|
|
1709
1870
|
},
|
|
1710
|
-
"description": "Removes
|
|
1871
|
+
"description": "Removes a domain from a project in Swagger.",
|
|
1711
1872
|
"examples": [
|
|
1712
|
-
"swaggerhub project:
|
|
1873
|
+
"swaggerhub project:domain:remove organization/project_name my_domain"
|
|
1713
1874
|
],
|
|
1714
1875
|
"flags": {
|
|
1715
1876
|
"help": {
|
|
@@ -1722,7 +1883,7 @@
|
|
|
1722
1883
|
},
|
|
1723
1884
|
"hasDynamicHelp": false,
|
|
1724
1885
|
"hiddenAliases": [],
|
|
1725
|
-
"id": "project:
|
|
1886
|
+
"id": "project:domain:remove",
|
|
1726
1887
|
"pluginAlias": "swaggerhub-cli",
|
|
1727
1888
|
"pluginName": "swaggerhub-cli",
|
|
1728
1889
|
"pluginType": "core",
|
|
@@ -1733,7 +1894,7 @@
|
|
|
1733
1894
|
"src",
|
|
1734
1895
|
"commands",
|
|
1735
1896
|
"project",
|
|
1736
|
-
"
|
|
1897
|
+
"domain",
|
|
1737
1898
|
"remove.js"
|
|
1738
1899
|
]
|
|
1739
1900
|
},
|
|
@@ -1741,14 +1902,14 @@
|
|
|
1741
1902
|
"aliases": [],
|
|
1742
1903
|
"args": {
|
|
1743
1904
|
"OWNER/PROJECT_NAME": {
|
|
1744
|
-
"description": "Project to list members of
|
|
1905
|
+
"description": "Project to list members of",
|
|
1745
1906
|
"name": "OWNER/PROJECT_NAME",
|
|
1746
1907
|
"required": true
|
|
1747
1908
|
}
|
|
1748
1909
|
},
|
|
1749
1910
|
"description": "list members of a project",
|
|
1750
1911
|
"examples": [
|
|
1751
|
-
"swaggerhub project:member:list
|
|
1912
|
+
"swaggerhub project:member:list organization/project_name"
|
|
1752
1913
|
],
|
|
1753
1914
|
"flags": {
|
|
1754
1915
|
"help": {
|
|
@@ -1777,5 +1938,5 @@
|
|
|
1777
1938
|
]
|
|
1778
1939
|
}
|
|
1779
1940
|
},
|
|
1780
|
-
"version": "0.
|
|
1941
|
+
"version": "0.14.0"
|
|
1781
1942
|
}
|