swaggerhub-cli 0.12.1 → 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 +239 -126
- package/oclif.manifest.json +372 -175
- package/package.json +8 -5
- 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 +13 -6
- 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 +27 -8
- 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/command/update-command.js +20 -4
- package/src/support/http/index.js +2 -1
- package/src/support/http/proxy-agent.js +25 -0
- 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,16 +754,24 @@
|
|
|
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
|
}
|
|
651
761
|
},
|
|
652
762
|
"description": "publish a domain version",
|
|
653
763
|
"examples": [
|
|
654
|
-
"swaggerhub domain:publish organization/domain/1.0.0"
|
|
764
|
+
"swaggerhub domain:publish organization/domain/1.0.0",
|
|
765
|
+
"swaggerhub domain:publish organization/domain/1.0.0 --force"
|
|
655
766
|
],
|
|
656
767
|
"flags": {
|
|
768
|
+
"force": {
|
|
769
|
+
"char": "f",
|
|
770
|
+
"description": "publish domain without prompting for confirmation",
|
|
771
|
+
"name": "force",
|
|
772
|
+
"allowNo": false,
|
|
773
|
+
"type": "boolean"
|
|
774
|
+
},
|
|
657
775
|
"help": {
|
|
658
776
|
"char": "h",
|
|
659
777
|
"description": "Show CLI help.",
|
|
@@ -677,11 +795,62 @@
|
|
|
677
795
|
"publish.js"
|
|
678
796
|
]
|
|
679
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
|
+
},
|
|
680
849
|
"domain:setdefault": {
|
|
681
850
|
"aliases": [],
|
|
682
851
|
"args": {
|
|
683
852
|
"OWNER/DOMAIN_NAME/VERSION": {
|
|
684
|
-
"description": "Domain to set as default on
|
|
853
|
+
"description": "Domain to set as default on Swagger",
|
|
685
854
|
"name": "OWNER/DOMAIN_NAME/VERSION",
|
|
686
855
|
"required": true
|
|
687
856
|
}
|
|
@@ -718,7 +887,7 @@
|
|
|
718
887
|
"aliases": [],
|
|
719
888
|
"args": {
|
|
720
889
|
"OWNER/DOMAIN_NAME/VERSION": {
|
|
721
|
-
"description": "Domain to unpublish on
|
|
890
|
+
"description": "Domain to unpublish on Swagger",
|
|
722
891
|
"name": "OWNER/DOMAIN_NAME/VERSION",
|
|
723
892
|
"required": true
|
|
724
893
|
}
|
|
@@ -755,12 +924,12 @@
|
|
|
755
924
|
"aliases": [],
|
|
756
925
|
"args": {
|
|
757
926
|
"OWNER/DOMAIN_NAME/[VERSION]": {
|
|
758
|
-
"description": "Domain to update on
|
|
927
|
+
"description": "Domain to update on Swagger",
|
|
759
928
|
"name": "OWNER/DOMAIN_NAME/[VERSION]",
|
|
760
929
|
"required": true
|
|
761
930
|
}
|
|
762
931
|
},
|
|
763
|
-
"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",
|
|
764
933
|
"examples": [
|
|
765
934
|
"swaggerhub domain:update organization/domain --file domain.yaml",
|
|
766
935
|
"swaggerhub domain:update organization/domain/1.0.0 --file domain.json",
|
|
@@ -780,7 +949,7 @@
|
|
|
780
949
|
"type": "option"
|
|
781
950
|
},
|
|
782
951
|
"visibility": {
|
|
783
|
-
"description": "visibility of domain in
|
|
952
|
+
"description": "visibility of domain in Swagger",
|
|
784
953
|
"name": "visibility",
|
|
785
954
|
"hasDynamicHelp": false,
|
|
786
955
|
"multiple": false,
|
|
@@ -832,47 +1001,25 @@
|
|
|
832
1001
|
"update.js"
|
|
833
1002
|
]
|
|
834
1003
|
},
|
|
835
|
-
"
|
|
1004
|
+
"integration:create": {
|
|
836
1005
|
"aliases": [],
|
|
837
1006
|
"args": {
|
|
838
|
-
"OWNER/
|
|
839
|
-
"description": "
|
|
840
|
-
"name": "OWNER/
|
|
1007
|
+
"OWNER/API_NAME/[VERSION]": {
|
|
1008
|
+
"description": "API to add integration to on Swagger",
|
|
1009
|
+
"name": "OWNER/API_NAME/[VERSION]",
|
|
841
1010
|
"required": true
|
|
842
1011
|
}
|
|
843
1012
|
},
|
|
844
|
-
"description": "
|
|
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",
|
|
845
1014
|
"examples": [
|
|
846
|
-
"swaggerhub
|
|
847
|
-
"swaggerhub project:create organization/new_project_name -a \"testapi1,testapi2\"",
|
|
848
|
-
"swaggerhub project:create organization/new_project_name --apis \"testapi1,testapi2\"",
|
|
849
|
-
"swaggerhub project:create organization/new_project_name -d \"testdomain3,testdomain4\"",
|
|
850
|
-
"swaggerhub project:create organization/new_project_name --domains \"testdomain3,testdomain4\"",
|
|
851
|
-
"swaggerhub project:create organization/new_project_name -a \"testapi1\" -d \"testdomain3\" --description \"description\""
|
|
1015
|
+
"swaggerhub integration:create organization/api/1.0.0 --file config.json"
|
|
852
1016
|
],
|
|
853
1017
|
"flags": {
|
|
854
|
-
"
|
|
855
|
-
"
|
|
856
|
-
"
|
|
857
|
-
"
|
|
858
|
-
"
|
|
859
|
-
"multiple": false,
|
|
860
|
-
"type": "option"
|
|
861
|
-
},
|
|
862
|
-
"apis": {
|
|
863
|
-
"char": "a",
|
|
864
|
-
"description": "Comma separated list of api names to include in project",
|
|
865
|
-
"name": "apis",
|
|
866
|
-
"required": false,
|
|
867
|
-
"hasDynamicHelp": false,
|
|
868
|
-
"multiple": false,
|
|
869
|
-
"type": "option"
|
|
870
|
-
},
|
|
871
|
-
"domains": {
|
|
872
|
-
"char": "d",
|
|
873
|
-
"description": "Comma separated list of domain names to include in project",
|
|
874
|
-
"name": "domains",
|
|
875
|
-
"required": false,
|
|
1018
|
+
"file": {
|
|
1019
|
+
"char": "f",
|
|
1020
|
+
"description": "location of integration configuration file",
|
|
1021
|
+
"name": "file",
|
|
1022
|
+
"required": true,
|
|
876
1023
|
"hasDynamicHelp": false,
|
|
877
1024
|
"multiple": false,
|
|
878
1025
|
"type": "option"
|
|
@@ -887,7 +1034,7 @@
|
|
|
887
1034
|
},
|
|
888
1035
|
"hasDynamicHelp": false,
|
|
889
1036
|
"hiddenAliases": [],
|
|
890
|
-
"id": "
|
|
1037
|
+
"id": "integration:create",
|
|
891
1038
|
"pluginAlias": "swaggerhub-cli",
|
|
892
1039
|
"pluginName": "swaggerhub-cli",
|
|
893
1040
|
"pluginType": "core",
|
|
@@ -897,22 +1044,22 @@
|
|
|
897
1044
|
"relativePath": [
|
|
898
1045
|
"src",
|
|
899
1046
|
"commands",
|
|
900
|
-
"
|
|
1047
|
+
"integration",
|
|
901
1048
|
"create.js"
|
|
902
1049
|
]
|
|
903
1050
|
},
|
|
904
|
-
"
|
|
1051
|
+
"integration:delete": {
|
|
905
1052
|
"aliases": [],
|
|
906
1053
|
"args": {
|
|
907
|
-
"OWNER/
|
|
908
|
-
"description": "
|
|
909
|
-
"name": "OWNER/
|
|
1054
|
+
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
1055
|
+
"description": "Integration to delete for given API on Swagger",
|
|
1056
|
+
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
910
1057
|
"required": true
|
|
911
1058
|
}
|
|
912
1059
|
},
|
|
913
|
-
"description": "
|
|
1060
|
+
"description": "deletes the integration from the given API.",
|
|
914
1061
|
"examples": [
|
|
915
|
-
"swaggerhub
|
|
1062
|
+
"swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704"
|
|
916
1063
|
],
|
|
917
1064
|
"flags": {
|
|
918
1065
|
"help": {
|
|
@@ -925,7 +1072,7 @@
|
|
|
925
1072
|
},
|
|
926
1073
|
"hasDynamicHelp": false,
|
|
927
1074
|
"hiddenAliases": [],
|
|
928
|
-
"id": "
|
|
1075
|
+
"id": "integration:delete",
|
|
929
1076
|
"pluginAlias": "swaggerhub-cli",
|
|
930
1077
|
"pluginName": "swaggerhub-cli",
|
|
931
1078
|
"pluginType": "core",
|
|
@@ -935,22 +1082,22 @@
|
|
|
935
1082
|
"relativePath": [
|
|
936
1083
|
"src",
|
|
937
1084
|
"commands",
|
|
938
|
-
"
|
|
1085
|
+
"integration",
|
|
939
1086
|
"delete.js"
|
|
940
1087
|
]
|
|
941
1088
|
},
|
|
942
|
-
"
|
|
1089
|
+
"integration:execute": {
|
|
943
1090
|
"aliases": [],
|
|
944
1091
|
"args": {
|
|
945
|
-
"OWNER/
|
|
946
|
-
"description": "
|
|
947
|
-
"name": "OWNER/
|
|
1092
|
+
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
1093
|
+
"description": "Integration to execute for given API on Swagger",
|
|
1094
|
+
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
948
1095
|
"required": true
|
|
949
1096
|
}
|
|
950
1097
|
},
|
|
951
|
-
"description": "
|
|
1098
|
+
"description": "executes an integration for the given API.",
|
|
952
1099
|
"examples": [
|
|
953
|
-
"swaggerhub
|
|
1100
|
+
"swaggerhub integration:execute organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704"
|
|
954
1101
|
],
|
|
955
1102
|
"flags": {
|
|
956
1103
|
"help": {
|
|
@@ -963,7 +1110,7 @@
|
|
|
963
1110
|
},
|
|
964
1111
|
"hasDynamicHelp": false,
|
|
965
1112
|
"hiddenAliases": [],
|
|
966
|
-
"id": "
|
|
1113
|
+
"id": "integration:execute",
|
|
967
1114
|
"pluginAlias": "swaggerhub-cli",
|
|
968
1115
|
"pluginName": "swaggerhub-cli",
|
|
969
1116
|
"pluginType": "core",
|
|
@@ -973,23 +1120,22 @@
|
|
|
973
1120
|
"relativePath": [
|
|
974
1121
|
"src",
|
|
975
1122
|
"commands",
|
|
976
|
-
"
|
|
977
|
-
"
|
|
1123
|
+
"integration",
|
|
1124
|
+
"execute.js"
|
|
978
1125
|
]
|
|
979
1126
|
},
|
|
980
|
-
"
|
|
1127
|
+
"integration:get": {
|
|
981
1128
|
"aliases": [],
|
|
982
1129
|
"args": {
|
|
983
|
-
"OWNER": {
|
|
984
|
-
"description": "
|
|
985
|
-
"name": "OWNER",
|
|
986
|
-
"required":
|
|
1130
|
+
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
1131
|
+
"description": "Integration to fetch for given API on Swagger",
|
|
1132
|
+
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
1133
|
+
"required": true
|
|
987
1134
|
}
|
|
988
1135
|
},
|
|
989
|
-
"description": "
|
|
1136
|
+
"description": "retrieves an integration for the given API.",
|
|
990
1137
|
"examples": [
|
|
991
|
-
"swaggerhub
|
|
992
|
-
"swaggerhub project:list organization"
|
|
1138
|
+
"swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704"
|
|
993
1139
|
],
|
|
994
1140
|
"flags": {
|
|
995
1141
|
"help": {
|
|
@@ -1002,7 +1148,7 @@
|
|
|
1002
1148
|
},
|
|
1003
1149
|
"hasDynamicHelp": false,
|
|
1004
1150
|
"hiddenAliases": [],
|
|
1005
|
-
"id": "
|
|
1151
|
+
"id": "integration:get",
|
|
1006
1152
|
"pluginAlias": "swaggerhub-cli",
|
|
1007
1153
|
"pluginName": "swaggerhub-cli",
|
|
1008
1154
|
"pluginType": "core",
|
|
@@ -1012,33 +1158,24 @@
|
|
|
1012
1158
|
"relativePath": [
|
|
1013
1159
|
"src",
|
|
1014
1160
|
"commands",
|
|
1015
|
-
"
|
|
1016
|
-
"
|
|
1161
|
+
"integration",
|
|
1162
|
+
"get.js"
|
|
1017
1163
|
]
|
|
1018
1164
|
},
|
|
1019
|
-
"integration:
|
|
1165
|
+
"integration:list": {
|
|
1020
1166
|
"aliases": [],
|
|
1021
1167
|
"args": {
|
|
1022
1168
|
"OWNER/API_NAME/[VERSION]": {
|
|
1023
|
-
"description": "API to
|
|
1169
|
+
"description": "API to list integrations for",
|
|
1024
1170
|
"name": "OWNER/API_NAME/[VERSION]",
|
|
1025
1171
|
"required": true
|
|
1026
1172
|
}
|
|
1027
1173
|
},
|
|
1028
|
-
"description": "
|
|
1174
|
+
"description": "list integrations on an API.",
|
|
1029
1175
|
"examples": [
|
|
1030
|
-
"swaggerhub integration:
|
|
1176
|
+
"swaggerhub integration:list organization/api/1.0.0"
|
|
1031
1177
|
],
|
|
1032
1178
|
"flags": {
|
|
1033
|
-
"file": {
|
|
1034
|
-
"char": "f",
|
|
1035
|
-
"description": "location of integration configuration file",
|
|
1036
|
-
"name": "file",
|
|
1037
|
-
"required": true,
|
|
1038
|
-
"hasDynamicHelp": false,
|
|
1039
|
-
"multiple": false,
|
|
1040
|
-
"type": "option"
|
|
1041
|
-
},
|
|
1042
1179
|
"help": {
|
|
1043
1180
|
"char": "h",
|
|
1044
1181
|
"description": "Show CLI help.",
|
|
@@ -1049,7 +1186,7 @@
|
|
|
1049
1186
|
},
|
|
1050
1187
|
"hasDynamicHelp": false,
|
|
1051
1188
|
"hiddenAliases": [],
|
|
1052
|
-
"id": "integration:
|
|
1189
|
+
"id": "integration:list",
|
|
1053
1190
|
"pluginAlias": "swaggerhub-cli",
|
|
1054
1191
|
"pluginName": "swaggerhub-cli",
|
|
1055
1192
|
"pluginType": "core",
|
|
@@ -1060,23 +1197,32 @@
|
|
|
1060
1197
|
"src",
|
|
1061
1198
|
"commands",
|
|
1062
1199
|
"integration",
|
|
1063
|
-
"
|
|
1200
|
+
"list.js"
|
|
1064
1201
|
]
|
|
1065
1202
|
},
|
|
1066
|
-
"integration:
|
|
1203
|
+
"integration:update": {
|
|
1067
1204
|
"aliases": [],
|
|
1068
1205
|
"args": {
|
|
1069
1206
|
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
1070
|
-
"description": "Integration to
|
|
1207
|
+
"description": "Integration to update for given API on Swagger",
|
|
1071
1208
|
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
1072
1209
|
"required": true
|
|
1073
1210
|
}
|
|
1074
1211
|
},
|
|
1075
|
-
"description": "
|
|
1212
|
+
"description": "update the configuration of an API integration.",
|
|
1076
1213
|
"examples": [
|
|
1077
|
-
"swaggerhub integration:
|
|
1214
|
+
"swaggerhub integration:update organization/api/1.0.0/503c2db6-448a-4678-abcd-0123456789abc --file config.json"
|
|
1078
1215
|
],
|
|
1079
1216
|
"flags": {
|
|
1217
|
+
"file": {
|
|
1218
|
+
"char": "f",
|
|
1219
|
+
"description": "location of integration configuration file",
|
|
1220
|
+
"name": "file",
|
|
1221
|
+
"required": true,
|
|
1222
|
+
"hasDynamicHelp": false,
|
|
1223
|
+
"multiple": false,
|
|
1224
|
+
"type": "option"
|
|
1225
|
+
},
|
|
1080
1226
|
"help": {
|
|
1081
1227
|
"char": "h",
|
|
1082
1228
|
"description": "Show CLI help.",
|
|
@@ -1087,7 +1233,7 @@
|
|
|
1087
1233
|
},
|
|
1088
1234
|
"hasDynamicHelp": false,
|
|
1089
1235
|
"hiddenAliases": [],
|
|
1090
|
-
"id": "integration:
|
|
1236
|
+
"id": "integration:update",
|
|
1091
1237
|
"pluginAlias": "swaggerhub-cli",
|
|
1092
1238
|
"pluginName": "swaggerhub-cli",
|
|
1093
1239
|
"pluginType": "core",
|
|
@@ -1098,23 +1244,54 @@
|
|
|
1098
1244
|
"src",
|
|
1099
1245
|
"commands",
|
|
1100
1246
|
"integration",
|
|
1101
|
-
"
|
|
1247
|
+
"update.js"
|
|
1102
1248
|
]
|
|
1103
1249
|
},
|
|
1104
|
-
"
|
|
1250
|
+
"project:create": {
|
|
1105
1251
|
"aliases": [],
|
|
1106
1252
|
"args": {
|
|
1107
|
-
"OWNER/
|
|
1108
|
-
"description": "
|
|
1109
|
-
"name": "OWNER/
|
|
1253
|
+
"OWNER/PROJECT_NAME": {
|
|
1254
|
+
"description": "The new project to create on Swagger",
|
|
1255
|
+
"name": "OWNER/PROJECT_NAME",
|
|
1110
1256
|
"required": true
|
|
1111
1257
|
}
|
|
1112
1258
|
},
|
|
1113
|
-
"description": "
|
|
1259
|
+
"description": "Creates a new project in Swagger.",
|
|
1114
1260
|
"examples": [
|
|
1115
|
-
"swaggerhub
|
|
1261
|
+
"swaggerhub project:create organization/new_project_name --description \"project description\"",
|
|
1262
|
+
"swaggerhub project:create organization/new_project_name -a \"testapi1,testapi2\"",
|
|
1263
|
+
"swaggerhub project:create organization/new_project_name --apis \"testapi1,testapi2\"",
|
|
1264
|
+
"swaggerhub project:create organization/new_project_name -d \"testdomain3,testdomain4\"",
|
|
1265
|
+
"swaggerhub project:create organization/new_project_name --domains \"testdomain3,testdomain4\"",
|
|
1266
|
+
"swaggerhub project:create organization/new_project_name -a \"testapi1\" -d \"testdomain3\" --description \"description\""
|
|
1116
1267
|
],
|
|
1117
1268
|
"flags": {
|
|
1269
|
+
"description": {
|
|
1270
|
+
"description": "Description of project",
|
|
1271
|
+
"name": "description",
|
|
1272
|
+
"required": false,
|
|
1273
|
+
"hasDynamicHelp": false,
|
|
1274
|
+
"multiple": false,
|
|
1275
|
+
"type": "option"
|
|
1276
|
+
},
|
|
1277
|
+
"apis": {
|
|
1278
|
+
"char": "a",
|
|
1279
|
+
"description": "Comma-separated list of API names to include in project",
|
|
1280
|
+
"name": "apis",
|
|
1281
|
+
"required": false,
|
|
1282
|
+
"hasDynamicHelp": false,
|
|
1283
|
+
"multiple": false,
|
|
1284
|
+
"type": "option"
|
|
1285
|
+
},
|
|
1286
|
+
"domains": {
|
|
1287
|
+
"char": "d",
|
|
1288
|
+
"description": "Comma-separated list of domain names to include in project",
|
|
1289
|
+
"name": "domains",
|
|
1290
|
+
"required": false,
|
|
1291
|
+
"hasDynamicHelp": false,
|
|
1292
|
+
"multiple": false,
|
|
1293
|
+
"type": "option"
|
|
1294
|
+
},
|
|
1118
1295
|
"help": {
|
|
1119
1296
|
"char": "h",
|
|
1120
1297
|
"description": "Show CLI help.",
|
|
@@ -1125,7 +1302,7 @@
|
|
|
1125
1302
|
},
|
|
1126
1303
|
"hasDynamicHelp": false,
|
|
1127
1304
|
"hiddenAliases": [],
|
|
1128
|
-
"id": "
|
|
1305
|
+
"id": "project:create",
|
|
1129
1306
|
"pluginAlias": "swaggerhub-cli",
|
|
1130
1307
|
"pluginName": "swaggerhub-cli",
|
|
1131
1308
|
"pluginType": "core",
|
|
@@ -1135,22 +1312,22 @@
|
|
|
1135
1312
|
"relativePath": [
|
|
1136
1313
|
"src",
|
|
1137
1314
|
"commands",
|
|
1138
|
-
"
|
|
1139
|
-
"
|
|
1315
|
+
"project",
|
|
1316
|
+
"create.js"
|
|
1140
1317
|
]
|
|
1141
1318
|
},
|
|
1142
|
-
"
|
|
1319
|
+
"project:delete": {
|
|
1143
1320
|
"aliases": [],
|
|
1144
1321
|
"args": {
|
|
1145
|
-
"OWNER/
|
|
1146
|
-
"description": "
|
|
1147
|
-
"name": "OWNER/
|
|
1322
|
+
"OWNER/PROJECT_NAME": {
|
|
1323
|
+
"description": "The project to delete on Swagger",
|
|
1324
|
+
"name": "OWNER/PROJECT_NAME",
|
|
1148
1325
|
"required": true
|
|
1149
1326
|
}
|
|
1150
1327
|
},
|
|
1151
|
-
"description": "
|
|
1328
|
+
"description": "Deletes a project from Swagger.",
|
|
1152
1329
|
"examples": [
|
|
1153
|
-
"swaggerhub
|
|
1330
|
+
"swaggerhub project:delete organization/project_name"
|
|
1154
1331
|
],
|
|
1155
1332
|
"flags": {
|
|
1156
1333
|
"help": {
|
|
@@ -1163,7 +1340,7 @@
|
|
|
1163
1340
|
},
|
|
1164
1341
|
"hasDynamicHelp": false,
|
|
1165
1342
|
"hiddenAliases": [],
|
|
1166
|
-
"id": "
|
|
1343
|
+
"id": "project:delete",
|
|
1167
1344
|
"pluginAlias": "swaggerhub-cli",
|
|
1168
1345
|
"pluginName": "swaggerhub-cli",
|
|
1169
1346
|
"pluginType": "core",
|
|
@@ -1173,22 +1350,22 @@
|
|
|
1173
1350
|
"relativePath": [
|
|
1174
1351
|
"src",
|
|
1175
1352
|
"commands",
|
|
1176
|
-
"
|
|
1177
|
-
"
|
|
1353
|
+
"project",
|
|
1354
|
+
"delete.js"
|
|
1178
1355
|
]
|
|
1179
1356
|
},
|
|
1180
|
-
"
|
|
1357
|
+
"project:get": {
|
|
1181
1358
|
"aliases": [],
|
|
1182
1359
|
"args": {
|
|
1183
|
-
"OWNER/
|
|
1184
|
-
"description": "
|
|
1185
|
-
"name": "OWNER/
|
|
1360
|
+
"OWNER/PROJECT_NAME": {
|
|
1361
|
+
"description": "The project to get details for on Swagger",
|
|
1362
|
+
"name": "OWNER/PROJECT_NAME",
|
|
1186
1363
|
"required": true
|
|
1187
1364
|
}
|
|
1188
1365
|
},
|
|
1189
|
-
"description": "
|
|
1366
|
+
"description": "Retrieves the details for a project.",
|
|
1190
1367
|
"examples": [
|
|
1191
|
-
"swaggerhub
|
|
1368
|
+
"swaggerhub project:get organization/project_name"
|
|
1192
1369
|
],
|
|
1193
1370
|
"flags": {
|
|
1194
1371
|
"help": {
|
|
@@ -1201,7 +1378,7 @@
|
|
|
1201
1378
|
},
|
|
1202
1379
|
"hasDynamicHelp": false,
|
|
1203
1380
|
"hiddenAliases": [],
|
|
1204
|
-
"id": "
|
|
1381
|
+
"id": "project:get",
|
|
1205
1382
|
"pluginAlias": "swaggerhub-cli",
|
|
1206
1383
|
"pluginName": "swaggerhub-cli",
|
|
1207
1384
|
"pluginType": "core",
|
|
@@ -1211,44 +1388,64 @@
|
|
|
1211
1388
|
"relativePath": [
|
|
1212
1389
|
"src",
|
|
1213
1390
|
"commands",
|
|
1214
|
-
"
|
|
1215
|
-
"
|
|
1391
|
+
"project",
|
|
1392
|
+
"get.js"
|
|
1216
1393
|
]
|
|
1217
1394
|
},
|
|
1218
|
-
"
|
|
1395
|
+
"project:list": {
|
|
1219
1396
|
"aliases": [],
|
|
1220
1397
|
"args": {
|
|
1221
|
-
"OWNER
|
|
1222
|
-
"description": "
|
|
1223
|
-
"name": "OWNER
|
|
1224
|
-
"required":
|
|
1398
|
+
"OWNER": {
|
|
1399
|
+
"description": "The organization to list projects for on Swagger",
|
|
1400
|
+
"name": "OWNER",
|
|
1401
|
+
"required": false
|
|
1225
1402
|
}
|
|
1226
1403
|
},
|
|
1227
|
-
"description": "
|
|
1404
|
+
"description": "list projects",
|
|
1228
1405
|
"examples": [
|
|
1229
|
-
"swaggerhub
|
|
1406
|
+
"swaggerhub project:list",
|
|
1407
|
+
"swaggerhub project:list organization",
|
|
1408
|
+
"swaggerhub project:list organization --limit 20 --order DESC",
|
|
1409
|
+
"swaggerhub project:list organization --page 2 --limit 20"
|
|
1230
1410
|
],
|
|
1231
1411
|
"flags": {
|
|
1232
|
-
"file": {
|
|
1233
|
-
"char": "f",
|
|
1234
|
-
"description": "location of integration configuration file",
|
|
1235
|
-
"name": "file",
|
|
1236
|
-
"required": true,
|
|
1237
|
-
"hasDynamicHelp": false,
|
|
1238
|
-
"multiple": false,
|
|
1239
|
-
"type": "option"
|
|
1240
|
-
},
|
|
1241
1412
|
"help": {
|
|
1242
1413
|
"char": "h",
|
|
1243
1414
|
"description": "Show CLI help.",
|
|
1244
1415
|
"name": "help",
|
|
1245
1416
|
"allowNo": false,
|
|
1246
1417
|
"type": "boolean"
|
|
1418
|
+
},
|
|
1419
|
+
"limit": {
|
|
1420
|
+
"char": "l",
|
|
1421
|
+
"description": "number of projects per page (1-100)",
|
|
1422
|
+
"name": "limit",
|
|
1423
|
+
"hasDynamicHelp": false,
|
|
1424
|
+
"multiple": false,
|
|
1425
|
+
"type": "option"
|
|
1426
|
+
},
|
|
1427
|
+
"page": {
|
|
1428
|
+
"description": "zero-based page of projects to return",
|
|
1429
|
+
"name": "page",
|
|
1430
|
+
"hasDynamicHelp": false,
|
|
1431
|
+
"multiple": false,
|
|
1432
|
+
"type": "option"
|
|
1433
|
+
},
|
|
1434
|
+
"order": {
|
|
1435
|
+
"description": "sort order of the projects",
|
|
1436
|
+
"name": "order",
|
|
1437
|
+
"hasDynamicHelp": false,
|
|
1438
|
+
"multiple": false,
|
|
1439
|
+
"options": [
|
|
1440
|
+
"ASC",
|
|
1441
|
+
"DESC"
|
|
1442
|
+
],
|
|
1443
|
+
"type": "option"
|
|
1247
1444
|
}
|
|
1248
1445
|
},
|
|
1249
1446
|
"hasDynamicHelp": false,
|
|
1250
1447
|
"hiddenAliases": [],
|
|
1251
|
-
"id": "
|
|
1448
|
+
"id": "project:list",
|
|
1252
1449
|
"pluginAlias": "swaggerhub-cli",
|
|
1253
1450
|
"pluginName": "swaggerhub-cli",
|
|
1254
1451
|
"pluginType": "core",
|
|
@@ -1258,15 +1455,15 @@
|
|
|
1258
1455
|
"relativePath": [
|
|
1259
1456
|
"src",
|
|
1260
1457
|
"commands",
|
|
1261
|
-
"
|
|
1262
|
-
"
|
|
1458
|
+
"project",
|
|
1459
|
+
"list.js"
|
|
1263
1460
|
]
|
|
1264
1461
|
},
|
|
1265
1462
|
"spectral:download": {
|
|
1266
1463
|
"aliases": [],
|
|
1267
1464
|
"args": {
|
|
1268
1465
|
"OWNER/RULESET_NAME": {
|
|
1269
|
-
"description": "Organization's Spectral ruleset to create or update on
|
|
1466
|
+
"description": "Organization's Spectral ruleset to create or update on Swagger",
|
|
1270
1467
|
"name": "OWNER/RULESET_NAME",
|
|
1271
1468
|
"required": true
|
|
1272
1469
|
},
|
|
@@ -1309,7 +1506,7 @@
|
|
|
1309
1506
|
"aliases": [],
|
|
1310
1507
|
"args": {
|
|
1311
1508
|
"OWNER/RULESET_NAME": {
|
|
1312
|
-
"description": "Organization's Spectral ruleset to create or update on
|
|
1509
|
+
"description": "Organization's Spectral ruleset to create or update on Swagger",
|
|
1313
1510
|
"name": "OWNER/RULESET_NAME",
|
|
1314
1511
|
"required": true
|
|
1315
1512
|
},
|
|
@@ -1352,12 +1549,12 @@
|
|
|
1352
1549
|
"aliases": [],
|
|
1353
1550
|
"args": {
|
|
1354
1551
|
"OWNER": {
|
|
1355
|
-
"description": "Which organization standardization rules to fetch from
|
|
1552
|
+
"description": "Which organization standardization rules to fetch from Swagger",
|
|
1356
1553
|
"name": "OWNER",
|
|
1357
1554
|
"required": true
|
|
1358
1555
|
}
|
|
1359
1556
|
},
|
|
1360
|
-
"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.",
|
|
1361
1558
|
"examples": [
|
|
1362
1559
|
"swaggerhub api:validate:download-rules myOrg -s",
|
|
1363
1560
|
"swaggerhub api:validate:download-rules myOrg --include-disabled-rules -s"
|
|
@@ -1408,12 +1605,12 @@
|
|
|
1408
1605
|
"aliases": [],
|
|
1409
1606
|
"args": {
|
|
1410
1607
|
"OWNER/API_NAME/[VERSION]": {
|
|
1411
|
-
"description": "API to fetch validation errors for
|
|
1608
|
+
"description": "API to fetch validation errors for",
|
|
1412
1609
|
"name": "OWNER/API_NAME/[VERSION]",
|
|
1413
1610
|
"required": true
|
|
1414
1611
|
}
|
|
1415
1612
|
},
|
|
1416
|
-
"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",
|
|
1417
1614
|
"examples": [
|
|
1418
1615
|
"swaggerhub api:validate organization/api/1.0.0",
|
|
1419
1616
|
"swaggerhub api:validate -c -j organization/api/1.0.0",
|
|
@@ -1462,10 +1659,10 @@
|
|
|
1462
1659
|
"api:validate:local": {
|
|
1463
1660
|
"aliases": [],
|
|
1464
1661
|
"args": {},
|
|
1465
|
-
"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",
|
|
1466
1663
|
"examples": [
|
|
1467
1664
|
"swaggerhub api:validate:local -o myOrg -f ./my-api.yaml -c -j ",
|
|
1468
|
-
"swaggerhub api:validate:local --organization myOrg --file ./my-api
|
|
1665
|
+
"swaggerhub api:validate:local --organization myOrg --file ./my-api.json --fail-on-critical --json"
|
|
1469
1666
|
],
|
|
1470
1667
|
"flags": {
|
|
1471
1668
|
"file": {
|
|
@@ -1529,12 +1726,12 @@
|
|
|
1529
1726
|
"aliases": [],
|
|
1530
1727
|
"args": {
|
|
1531
1728
|
"OWNER/PROJECT_NAME": {
|
|
1532
|
-
"description": "The project to add the API to on
|
|
1729
|
+
"description": "The project to add the API to on Swagger",
|
|
1533
1730
|
"name": "OWNER/PROJECT_NAME",
|
|
1534
1731
|
"required": true
|
|
1535
1732
|
},
|
|
1536
1733
|
"API": {
|
|
1537
|
-
"description": "The name of the API on
|
|
1734
|
+
"description": "The name of the API on Swagger to add",
|
|
1538
1735
|
"name": "API",
|
|
1539
1736
|
"required": true
|
|
1540
1737
|
}
|
|
@@ -1573,17 +1770,17 @@
|
|
|
1573
1770
|
"aliases": [],
|
|
1574
1771
|
"args": {
|
|
1575
1772
|
"OWNER/PROJECT_NAME": {
|
|
1576
|
-
"description": "The project to remove the API from on
|
|
1773
|
+
"description": "The project to remove the API from on Swagger",
|
|
1577
1774
|
"name": "OWNER/PROJECT_NAME",
|
|
1578
1775
|
"required": true
|
|
1579
1776
|
},
|
|
1580
1777
|
"API": {
|
|
1581
|
-
"description": "The name of the API on
|
|
1778
|
+
"description": "The name of the API on Swagger to remove",
|
|
1582
1779
|
"name": "API",
|
|
1583
1780
|
"required": true
|
|
1584
1781
|
}
|
|
1585
1782
|
},
|
|
1586
|
-
"description": "Removes an API from a project in
|
|
1783
|
+
"description": "Removes an API from a project in Swagger.",
|
|
1587
1784
|
"examples": [
|
|
1588
1785
|
"swaggerhub project:api:remove organization/project_name my_api"
|
|
1589
1786
|
],
|
|
@@ -1617,12 +1814,12 @@
|
|
|
1617
1814
|
"aliases": [],
|
|
1618
1815
|
"args": {
|
|
1619
1816
|
"OWNER/PROJECT_NAME": {
|
|
1620
|
-
"description": "The project to add the domain to on
|
|
1817
|
+
"description": "The project to add the domain to on Swagger",
|
|
1621
1818
|
"name": "OWNER/PROJECT_NAME",
|
|
1622
1819
|
"required": true
|
|
1623
1820
|
},
|
|
1624
1821
|
"DOMAIN": {
|
|
1625
|
-
"description": "The name of the domain on
|
|
1822
|
+
"description": "The name of the domain on Swagger to add",
|
|
1626
1823
|
"name": "DOMAIN",
|
|
1627
1824
|
"required": true
|
|
1628
1825
|
}
|
|
@@ -1661,17 +1858,17 @@
|
|
|
1661
1858
|
"aliases": [],
|
|
1662
1859
|
"args": {
|
|
1663
1860
|
"OWNER/PROJECT_NAME": {
|
|
1664
|
-
"description": "The project to remove the domain from on
|
|
1861
|
+
"description": "The project to remove the domain from on Swagger",
|
|
1665
1862
|
"name": "OWNER/PROJECT_NAME",
|
|
1666
1863
|
"required": true
|
|
1667
1864
|
},
|
|
1668
1865
|
"DOMAIN": {
|
|
1669
|
-
"description": "The name of the domain on
|
|
1866
|
+
"description": "The name of the domain on Swagger to remove",
|
|
1670
1867
|
"name": "DOMAIN",
|
|
1671
1868
|
"required": true
|
|
1672
1869
|
}
|
|
1673
1870
|
},
|
|
1674
|
-
"description": "Removes a domain from a project in
|
|
1871
|
+
"description": "Removes a domain from a project in Swagger.",
|
|
1675
1872
|
"examples": [
|
|
1676
1873
|
"swaggerhub project:domain:remove organization/project_name my_domain"
|
|
1677
1874
|
],
|
|
@@ -1705,14 +1902,14 @@
|
|
|
1705
1902
|
"aliases": [],
|
|
1706
1903
|
"args": {
|
|
1707
1904
|
"OWNER/PROJECT_NAME": {
|
|
1708
|
-
"description": "Project to list members of
|
|
1905
|
+
"description": "Project to list members of",
|
|
1709
1906
|
"name": "OWNER/PROJECT_NAME",
|
|
1710
1907
|
"required": true
|
|
1711
1908
|
}
|
|
1712
1909
|
},
|
|
1713
1910
|
"description": "list members of a project",
|
|
1714
1911
|
"examples": [
|
|
1715
|
-
"swaggerhub project:member:list
|
|
1912
|
+
"swaggerhub project:member:list organization/project_name"
|
|
1716
1913
|
],
|
|
1717
1914
|
"flags": {
|
|
1718
1915
|
"help": {
|
|
@@ -1741,5 +1938,5 @@
|
|
|
1741
1938
|
]
|
|
1742
1939
|
}
|
|
1743
1940
|
},
|
|
1744
|
-
"version": "0.
|
|
1941
|
+
"version": "0.14.0"
|
|
1745
1942
|
}
|