swaggerhub-cli 0.12.1 → 0.13.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 +67 -41
- package/oclif.manifest.json +204 -168
- package/package.json +7 -4
- package/src/commands/domain/publish.js +12 -5
- package/src/commands/project/list.js +26 -7
- 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/README.md
CHANGED
|
@@ -9,6 +9,7 @@ The SwaggerHub CLI enables teams to build automation and workflows around Swagge
|
|
|
9
9
|
* [Requirements](#requirements)
|
|
10
10
|
* [Installation](#installation)
|
|
11
11
|
* [Setup](#setup)
|
|
12
|
+
* [Using a proxy](#using-a-proxy)
|
|
12
13
|
* [Additional configuration for SwaggerHub On-Premise](#additional-configuration-for-swaggerhub-on-premise)
|
|
13
14
|
* [Usage](#usage)
|
|
14
15
|
* [Commands](#commands)
|
|
@@ -16,7 +17,7 @@ The SwaggerHub CLI enables teams to build automation and workflows around Swagge
|
|
|
16
17
|
* [Contributing](#contributing)
|
|
17
18
|
<!-- tocstop -->
|
|
18
19
|
# Requirements
|
|
19
|
-
Node.js
|
|
20
|
+
Node.js 22.9 or later.
|
|
20
21
|
|
|
21
22
|
# Installation
|
|
22
23
|
```sh-session
|
|
@@ -38,6 +39,20 @@ $ swaggerhub configure
|
|
|
38
39
|
|
|
39
40
|
Environment variables take precedence over the configuration file created by this command.
|
|
40
41
|
|
|
42
|
+
# Using a proxy
|
|
43
|
+
|
|
44
|
+
The CLI honors the standard proxy environment variables (lowercase variants also work):
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
export HTTPS_PROXY=http://proxy.example.com:8080 # used for https:// URLs, including the default https://api.swaggerhub.com
|
|
48
|
+
export HTTP_PROXY=http://proxy.example.com:8080 # used for http:// URLs, e.g. an on-premise instance served over HTTP
|
|
49
|
+
export NO_PROXY=localhost,.internal.example.com # hosts that should bypass the proxy
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Proxy credentials can be included in the URL: `http://user:password@proxy.example.com:8080`. Always include the scheme (`http://` or `https://`) in the proxy URL.
|
|
53
|
+
|
|
54
|
+
HTTPS requests are tunnelled through the proxy using `CONNECT`. If your proxy intercepts TLS, see `NODE_EXTRA_CA_CERTS` below. SOCKS proxies are not supported.
|
|
55
|
+
|
|
41
56
|
# Additional configuration for SwaggerHub On-Premise
|
|
42
57
|
|
|
43
58
|
If your SwaggerHub On-Premise instance uses a **self-signed or privately signed SSL certificate**, there are additional steps required to make the SwaggerHub CLI trust this certificate.
|
|
@@ -189,7 +204,7 @@ EXAMPLES
|
|
|
189
204
|
$ swaggerhub api:create organization/api/1.0.0 --published=publish --setdefault --file api.json
|
|
190
205
|
```
|
|
191
206
|
|
|
192
|
-
_See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
207
|
+
_See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/create.js)_
|
|
193
208
|
|
|
194
209
|
## `swaggerhub api:delete`
|
|
195
210
|
|
|
@@ -218,7 +233,7 @@ EXAMPLES
|
|
|
218
233
|
$ swaggerhub api:delete organization/api --force
|
|
219
234
|
```
|
|
220
235
|
|
|
221
|
-
_See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
236
|
+
_See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/delete.js)_
|
|
222
237
|
|
|
223
238
|
## `swaggerhub api:get`
|
|
224
239
|
|
|
@@ -248,7 +263,7 @@ EXAMPLES
|
|
|
248
263
|
$ swaggerhub api:get organization/api/1.0.0 --json
|
|
249
264
|
```
|
|
250
265
|
|
|
251
|
-
_See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
266
|
+
_See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/get.js)_
|
|
252
267
|
|
|
253
268
|
## `swaggerhub api:publish`
|
|
254
269
|
|
|
@@ -274,7 +289,7 @@ EXAMPLES
|
|
|
274
289
|
$ swaggerhub api:publish organization/api/1.0.0 --force
|
|
275
290
|
```
|
|
276
291
|
|
|
277
|
-
_See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
292
|
+
_See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/publish.js)_
|
|
278
293
|
|
|
279
294
|
## `swaggerhub api:rename`
|
|
280
295
|
|
|
@@ -298,7 +313,7 @@ EXAMPLES
|
|
|
298
313
|
$ swaggerhub api:rename organization/apiOldName apiNewName
|
|
299
314
|
```
|
|
300
315
|
|
|
301
|
-
_See code: [src/commands/api/rename.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
316
|
+
_See code: [src/commands/api/rename.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/rename.js)_
|
|
302
317
|
|
|
303
318
|
## `swaggerhub api:setdefault`
|
|
304
319
|
|
|
@@ -321,7 +336,7 @@ EXAMPLES
|
|
|
321
336
|
$ swaggerhub api:setdefault organization/api/2.0.0
|
|
322
337
|
```
|
|
323
338
|
|
|
324
|
-
_See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
339
|
+
_See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/setdefault.js)_
|
|
325
340
|
|
|
326
341
|
## `swaggerhub api:unpublish`
|
|
327
342
|
|
|
@@ -344,7 +359,7 @@ EXAMPLES
|
|
|
344
359
|
$ swaggerhub api:unpublish organization/api/1.0.0
|
|
345
360
|
```
|
|
346
361
|
|
|
347
|
-
_See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
362
|
+
_See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/unpublish.js)_
|
|
348
363
|
|
|
349
364
|
## `swaggerhub api:update`
|
|
350
365
|
|
|
@@ -388,7 +403,7 @@ EXAMPLES
|
|
|
388
403
|
$ swaggerhub api:update organization/api/1.0.0 --visibility=private
|
|
389
404
|
```
|
|
390
405
|
|
|
391
|
-
_See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
406
|
+
_See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/update.js)_
|
|
392
407
|
|
|
393
408
|
## `swaggerhub api:validate`
|
|
394
409
|
|
|
@@ -422,7 +437,7 @@ EXAMPLES
|
|
|
422
437
|
$ swaggerhub api:validate --fail-on-critical --json organization/api
|
|
423
438
|
```
|
|
424
439
|
|
|
425
|
-
_See code: [src/commands/api/validate/index.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
440
|
+
_See code: [src/commands/api/validate/index.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/validate/index.js)_
|
|
426
441
|
|
|
427
442
|
## `swaggerhub api:validate:download-rules`
|
|
428
443
|
|
|
@@ -453,7 +468,7 @@ EXAMPLES
|
|
|
453
468
|
$ swaggerhub api:validate:download-rules myOrg --include-disabled-rules -s
|
|
454
469
|
```
|
|
455
470
|
|
|
456
|
-
_See code: [src/commands/api/validate/download-rules.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
471
|
+
_See code: [src/commands/api/validate/download-rules.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/validate/download-rules.js)_
|
|
457
472
|
|
|
458
473
|
## `swaggerhub api:validate:local`
|
|
459
474
|
|
|
@@ -483,7 +498,7 @@ EXAMPLES
|
|
|
483
498
|
$ swaggerhub api:validate:local --organization myOrg --file ./my-api/json --fail-on-critical --json
|
|
484
499
|
```
|
|
485
500
|
|
|
486
|
-
_See code: [src/commands/api/validate/local.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
501
|
+
_See code: [src/commands/api/validate/local.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/validate/local.js)_
|
|
487
502
|
|
|
488
503
|
## `swaggerhub configure`
|
|
489
504
|
|
|
@@ -506,7 +521,7 @@ DESCRIPTION
|
|
|
506
521
|
settings.
|
|
507
522
|
```
|
|
508
523
|
|
|
509
|
-
_See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
524
|
+
_See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/configure.js)_
|
|
510
525
|
|
|
511
526
|
## `swaggerhub domain:create`
|
|
512
527
|
|
|
@@ -547,7 +562,7 @@ EXAMPLES
|
|
|
547
562
|
$ swaggerhub domain:create organization/domain/1.0.0 --publish --setdefault --file domain.json
|
|
548
563
|
```
|
|
549
564
|
|
|
550
|
-
_See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
565
|
+
_See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/create.js)_
|
|
551
566
|
|
|
552
567
|
## `swaggerhub domain:delete`
|
|
553
568
|
|
|
@@ -576,7 +591,7 @@ EXAMPLES
|
|
|
576
591
|
$ swaggerhub domain:delete organization/domain --force
|
|
577
592
|
```
|
|
578
593
|
|
|
579
|
-
_See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
594
|
+
_See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/delete.js)_
|
|
580
595
|
|
|
581
596
|
## `swaggerhub domain:get`
|
|
582
597
|
|
|
@@ -605,7 +620,7 @@ EXAMPLES
|
|
|
605
620
|
$ swaggerhub domain:get organization/domain/1.0.0 --json
|
|
606
621
|
```
|
|
607
622
|
|
|
608
|
-
_See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
623
|
+
_See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/get.js)_
|
|
609
624
|
|
|
610
625
|
## `swaggerhub domain:publish`
|
|
611
626
|
|
|
@@ -613,22 +628,25 @@ publish a domain version
|
|
|
613
628
|
|
|
614
629
|
```
|
|
615
630
|
USAGE
|
|
616
|
-
$ swaggerhub domain:publish OWNER/DOMAIN_NAME/VERSION [-h]
|
|
631
|
+
$ swaggerhub domain:publish OWNER/DOMAIN_NAME/VERSION [-f] [-h]
|
|
617
632
|
|
|
618
633
|
ARGUMENTS
|
|
619
634
|
OWNER/DOMAIN_NAME/VERSION Domain to publish on SwaggerHub
|
|
620
635
|
|
|
621
636
|
FLAGS
|
|
622
|
-
-
|
|
637
|
+
-f, --force publish domain without prompting for confirmation
|
|
638
|
+
-h, --help Show CLI help.
|
|
623
639
|
|
|
624
640
|
DESCRIPTION
|
|
625
641
|
publish a domain version
|
|
626
642
|
|
|
627
643
|
EXAMPLES
|
|
628
644
|
$ swaggerhub domain:publish organization/domain/1.0.0
|
|
645
|
+
|
|
646
|
+
$ swaggerhub domain:publish organization/domain/1.0.0 --force
|
|
629
647
|
```
|
|
630
648
|
|
|
631
|
-
_See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
649
|
+
_See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/publish.js)_
|
|
632
650
|
|
|
633
651
|
## `swaggerhub domain:setdefault`
|
|
634
652
|
|
|
@@ -651,7 +669,7 @@ EXAMPLES
|
|
|
651
669
|
$ swaggerhub domain:setdefault organization/domain/2.0.0
|
|
652
670
|
```
|
|
653
671
|
|
|
654
|
-
_See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
672
|
+
_See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/setdefault.js)_
|
|
655
673
|
|
|
656
674
|
## `swaggerhub domain:unpublish`
|
|
657
675
|
|
|
@@ -674,7 +692,7 @@ EXAMPLES
|
|
|
674
692
|
$ swaggerhub domain:unpublish organization/domain/1.0.0
|
|
675
693
|
```
|
|
676
694
|
|
|
677
|
-
_See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
695
|
+
_See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/unpublish.js)_
|
|
678
696
|
|
|
679
697
|
## `swaggerhub domain:update`
|
|
680
698
|
|
|
@@ -718,7 +736,7 @@ EXAMPLES
|
|
|
718
736
|
$ swaggerhub domain:update organization/domain/1.0.0 --visibility=private
|
|
719
737
|
```
|
|
720
738
|
|
|
721
|
-
_See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
739
|
+
_See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/update.js)_
|
|
722
740
|
|
|
723
741
|
## `swaggerhub help`
|
|
724
742
|
|
|
@@ -766,7 +784,7 @@ EXAMPLES
|
|
|
766
784
|
$ swaggerhub integration:create organization/api/1.0.0 --file config.json
|
|
767
785
|
```
|
|
768
786
|
|
|
769
|
-
_See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
787
|
+
_See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/integration/create.js)_
|
|
770
788
|
|
|
771
789
|
## `swaggerhub integration:delete`
|
|
772
790
|
|
|
@@ -789,7 +807,7 @@ EXAMPLES
|
|
|
789
807
|
$ swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
790
808
|
```
|
|
791
809
|
|
|
792
|
-
_See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
810
|
+
_See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/integration/delete.js)_
|
|
793
811
|
|
|
794
812
|
## `swaggerhub integration:execute`
|
|
795
813
|
|
|
@@ -812,7 +830,7 @@ EXAMPLES
|
|
|
812
830
|
$ swaggerhub integration:execute organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
813
831
|
```
|
|
814
832
|
|
|
815
|
-
_See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
833
|
+
_See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/integration/execute.js)_
|
|
816
834
|
|
|
817
835
|
## `swaggerhub integration:get`
|
|
818
836
|
|
|
@@ -835,7 +853,7 @@ EXAMPLES
|
|
|
835
853
|
$ swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
836
854
|
```
|
|
837
855
|
|
|
838
|
-
_See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
856
|
+
_See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/integration/get.js)_
|
|
839
857
|
|
|
840
858
|
## `swaggerhub integration:list`
|
|
841
859
|
|
|
@@ -858,7 +876,7 @@ EXAMPLES
|
|
|
858
876
|
$ swaggerhub integration:list organization/api/1.0.0
|
|
859
877
|
```
|
|
860
878
|
|
|
861
|
-
_See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
879
|
+
_See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/integration/list.js)_
|
|
862
880
|
|
|
863
881
|
## `swaggerhub integration:update`
|
|
864
882
|
|
|
@@ -882,7 +900,7 @@ EXAMPLES
|
|
|
882
900
|
$ swaggerhub integration:update organization/api/1.0.0/503c2db6-448a-4678-abcd-0123456789abc --file config.json
|
|
883
901
|
```
|
|
884
902
|
|
|
885
|
-
_See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
903
|
+
_See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/integration/update.js)_
|
|
886
904
|
|
|
887
905
|
## `swaggerhub plugins`
|
|
888
906
|
|
|
@@ -1196,7 +1214,7 @@ EXAMPLES
|
|
|
1196
1214
|
$ swaggerhub project:api:add organization/project_name my_api
|
|
1197
1215
|
```
|
|
1198
1216
|
|
|
1199
|
-
_See code: [src/commands/project/api/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1217
|
+
_See code: [src/commands/project/api/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/project/api/add.js)_
|
|
1200
1218
|
|
|
1201
1219
|
## `swaggerhub project:api:remove`
|
|
1202
1220
|
|
|
@@ -1220,7 +1238,7 @@ EXAMPLES
|
|
|
1220
1238
|
$ swaggerhub project:api:remove organization/project_name my_api
|
|
1221
1239
|
```
|
|
1222
1240
|
|
|
1223
|
-
_See code: [src/commands/project/api/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1241
|
+
_See code: [src/commands/project/api/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/project/api/remove.js)_
|
|
1224
1242
|
|
|
1225
1243
|
## `swaggerhub project:create`
|
|
1226
1244
|
|
|
@@ -1256,7 +1274,7 @@ EXAMPLES
|
|
|
1256
1274
|
$ swaggerhub project:create organization/new_project_name -a "testapi1" -d "testdomain3" --description "description"
|
|
1257
1275
|
```
|
|
1258
1276
|
|
|
1259
|
-
_See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1277
|
+
_See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/project/create.js)_
|
|
1260
1278
|
|
|
1261
1279
|
## `swaggerhub project:delete`
|
|
1262
1280
|
|
|
@@ -1279,7 +1297,7 @@ EXAMPLES
|
|
|
1279
1297
|
$ swaggerhub project:delete organization/project_name
|
|
1280
1298
|
```
|
|
1281
1299
|
|
|
1282
|
-
_See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1300
|
+
_See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/project/delete.js)_
|
|
1283
1301
|
|
|
1284
1302
|
## `swaggerhub project:domain:add`
|
|
1285
1303
|
|
|
@@ -1303,7 +1321,7 @@ EXAMPLES
|
|
|
1303
1321
|
$ swaggerhub project:domain:add organization/project_name my_domain
|
|
1304
1322
|
```
|
|
1305
1323
|
|
|
1306
|
-
_See code: [src/commands/project/domain/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1324
|
+
_See code: [src/commands/project/domain/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/project/domain/add.js)_
|
|
1307
1325
|
|
|
1308
1326
|
## `swaggerhub project:domain:remove`
|
|
1309
1327
|
|
|
@@ -1327,7 +1345,7 @@ EXAMPLES
|
|
|
1327
1345
|
$ swaggerhub project:domain:remove organization/project_name my_domain
|
|
1328
1346
|
```
|
|
1329
1347
|
|
|
1330
|
-
_See code: [src/commands/project/domain/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1348
|
+
_See code: [src/commands/project/domain/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/project/domain/remove.js)_
|
|
1331
1349
|
|
|
1332
1350
|
## `swaggerhub project:get`
|
|
1333
1351
|
|
|
@@ -1350,7 +1368,7 @@ EXAMPLES
|
|
|
1350
1368
|
$ swaggerhub project:get organization/project_name
|
|
1351
1369
|
```
|
|
1352
1370
|
|
|
1353
|
-
_See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1371
|
+
_See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/project/get.js)_
|
|
1354
1372
|
|
|
1355
1373
|
## `swaggerhub project:list`
|
|
1356
1374
|
|
|
@@ -1358,13 +1376,17 @@ list projects
|
|
|
1358
1376
|
|
|
1359
1377
|
```
|
|
1360
1378
|
USAGE
|
|
1361
|
-
$ swaggerhub project:list [OWNER] [-h]
|
|
1379
|
+
$ swaggerhub project:list [OWNER] [-h] [-l <value>] [--page <value>] [--order ASC|DESC]
|
|
1362
1380
|
|
|
1363
1381
|
ARGUMENTS
|
|
1364
1382
|
OWNER The organization to list projects for on Swaggerhub
|
|
1365
1383
|
|
|
1366
1384
|
FLAGS
|
|
1367
|
-
-h, --help
|
|
1385
|
+
-h, --help Show CLI help.
|
|
1386
|
+
-l, --limit=<value> number of projects per page (1-100)
|
|
1387
|
+
--order=<option> sort order of the projects
|
|
1388
|
+
<options: ASC|DESC>
|
|
1389
|
+
--page=<value> zero-based page of projects to return
|
|
1368
1390
|
|
|
1369
1391
|
DESCRIPTION
|
|
1370
1392
|
list projects
|
|
@@ -1373,9 +1395,13 @@ EXAMPLES
|
|
|
1373
1395
|
$ swaggerhub project:list
|
|
1374
1396
|
|
|
1375
1397
|
$ swaggerhub project:list organization
|
|
1398
|
+
|
|
1399
|
+
$ swaggerhub project:list organization --limit 20 --order DESC
|
|
1400
|
+
|
|
1401
|
+
$ swaggerhub project:list organization --page 2 --limit 20
|
|
1376
1402
|
```
|
|
1377
1403
|
|
|
1378
|
-
_See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1404
|
+
_See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/project/list.js)_
|
|
1379
1405
|
|
|
1380
1406
|
## `swaggerhub project:member:list`
|
|
1381
1407
|
|
|
@@ -1398,7 +1424,7 @@ EXAMPLES
|
|
|
1398
1424
|
$ swaggerhub project:member:list organisation/project_name
|
|
1399
1425
|
```
|
|
1400
1426
|
|
|
1401
|
-
_See code: [src/commands/project/member/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1427
|
+
_See code: [src/commands/project/member/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/project/member/list.js)_
|
|
1402
1428
|
|
|
1403
1429
|
## `swaggerhub spectral:download`
|
|
1404
1430
|
|
|
@@ -1422,7 +1448,7 @@ EXAMPLES
|
|
|
1422
1448
|
$ swaggerhub spectral:download my_organization/my_api_ruleset rules/
|
|
1423
1449
|
```
|
|
1424
1450
|
|
|
1425
|
-
_See code: [src/commands/spectral/download.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1451
|
+
_See code: [src/commands/spectral/download.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/spectral/download.js)_
|
|
1426
1452
|
|
|
1427
1453
|
## `swaggerhub spectral:upload`
|
|
1428
1454
|
|
|
@@ -1446,7 +1472,7 @@ EXAMPLES
|
|
|
1446
1472
|
$ swaggerhub spectral:upload my_organization/my_api_ruleset rules/
|
|
1447
1473
|
```
|
|
1448
1474
|
|
|
1449
|
-
_See code: [src/commands/spectral/upload.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1475
|
+
_See code: [src/commands/spectral/upload.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/spectral/upload.js)_
|
|
1450
1476
|
<!-- commandsstop -->
|
|
1451
1477
|
|
|
1452
1478
|
# Plugins
|