swaggerhub-cli 0.8.1 → 0.9.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 +89 -56
- package/oclif.manifest.json +1017 -626
- package/package.json +5 -5
- package/src/commands/api/validate/download-rules.js +58 -0
- package/src/requests/standardization.js +14 -1
package/README.md
CHANGED
|
@@ -110,6 +110,7 @@ USAGE
|
|
|
110
110
|
* [`swaggerhub api:unpublish OWNER/API_NAME/VERSION`](#swaggerhub-apiunpublish)
|
|
111
111
|
* [`swaggerhub api:update OWNER/API_NAME/[VERSION]`](#swaggerhub-apiupdate)
|
|
112
112
|
* [`swaggerhub api:validate OWNER/API_NAME/[VERSION]`](#swaggerhub-apivalidate)
|
|
113
|
+
* [`swaggerhub api:validate:download-rules OWNER`](#swaggerhub-apivalidatedownload)
|
|
113
114
|
* [`swaggerhub api:validate:local`](#swaggerhub-apivalidatelocal)
|
|
114
115
|
* [`swaggerhub configure`](#swaggerhub-configure)
|
|
115
116
|
* [`swaggerhub domain:create OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domaincreate)
|
|
@@ -151,8 +152,8 @@ creates a new API / API version from a YAML/JSON file
|
|
|
151
152
|
|
|
152
153
|
```
|
|
153
154
|
USAGE
|
|
154
|
-
$ swaggerhub api:create OWNER/API_NAME/[VERSION] [
|
|
155
|
-
|
|
155
|
+
$ swaggerhub api:create OWNER/API_NAME/[VERSION] [--visibility public|private] (--published publish|unpublish
|
|
156
|
+
-f <value>) [--setdefault ] [-h]
|
|
156
157
|
|
|
157
158
|
ARGUMENTS
|
|
158
159
|
OWNER/API_NAME/[VERSION] API to create on SwaggerHub
|
|
@@ -184,7 +185,7 @@ EXAMPLES
|
|
|
184
185
|
$ swaggerhub api:create organization/api/1.0.0 --published=publish --setdefault --file api.json
|
|
185
186
|
```
|
|
186
187
|
|
|
187
|
-
_See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
188
|
+
_See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/api/create.js)_
|
|
188
189
|
|
|
189
190
|
## `swaggerhub api:delete`
|
|
190
191
|
|
|
@@ -192,7 +193,7 @@ delete an API or API version
|
|
|
192
193
|
|
|
193
194
|
```
|
|
194
195
|
USAGE
|
|
195
|
-
$ swaggerhub api:delete OWNER/API_NAME/[VERSION] [-
|
|
196
|
+
$ swaggerhub api:delete OWNER/API_NAME/[VERSION] [-f] [-h]
|
|
196
197
|
|
|
197
198
|
ARGUMENTS
|
|
198
199
|
OWNER/API_NAME/[VERSION] API to delete on SwaggerHub
|
|
@@ -213,7 +214,7 @@ EXAMPLES
|
|
|
213
214
|
$ swaggerhub api:delete organization/api --force
|
|
214
215
|
```
|
|
215
216
|
|
|
216
|
-
_See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
217
|
+
_See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/api/delete.js)_
|
|
217
218
|
|
|
218
219
|
## `swaggerhub api:get`
|
|
219
220
|
|
|
@@ -221,7 +222,7 @@ fetches an API definition
|
|
|
221
222
|
|
|
222
223
|
```
|
|
223
224
|
USAGE
|
|
224
|
-
$ swaggerhub api:get OWNER/API_NAME/[VERSION] [-
|
|
225
|
+
$ swaggerhub api:get OWNER/API_NAME/[VERSION] [-j] [-r] [-h]
|
|
225
226
|
|
|
226
227
|
ARGUMENTS
|
|
227
228
|
OWNER/API_NAME/[VERSION] API to fetch from Swaggerhub
|
|
@@ -243,7 +244,7 @@ EXAMPLES
|
|
|
243
244
|
$ swaggerhub api:get organization/api/1.0.0 --json
|
|
244
245
|
```
|
|
245
246
|
|
|
246
|
-
_See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
247
|
+
_See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/api/get.js)_
|
|
247
248
|
|
|
248
249
|
## `swaggerhub api:publish`
|
|
249
250
|
|
|
@@ -251,7 +252,7 @@ publish an API version
|
|
|
251
252
|
|
|
252
253
|
```
|
|
253
254
|
USAGE
|
|
254
|
-
$ swaggerhub api:publish OWNER/API_NAME/VERSION [-
|
|
255
|
+
$ swaggerhub api:publish OWNER/API_NAME/VERSION [-f] [-h]
|
|
255
256
|
|
|
256
257
|
ARGUMENTS
|
|
257
258
|
OWNER/API_NAME/VERSION API to publish on Swaggerhub
|
|
@@ -269,7 +270,7 @@ EXAMPLES
|
|
|
269
270
|
$ swaggerhub api:publish organization/api/1.0.0 --force
|
|
270
271
|
```
|
|
271
272
|
|
|
272
|
-
_See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
273
|
+
_See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/api/publish.js)_
|
|
273
274
|
|
|
274
275
|
## `swaggerhub api:setdefault`
|
|
275
276
|
|
|
@@ -292,7 +293,7 @@ EXAMPLES
|
|
|
292
293
|
$ swaggerhub api:setdefault organization/api/2.0.0
|
|
293
294
|
```
|
|
294
295
|
|
|
295
|
-
_See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
296
|
+
_See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/api/setdefault.js)_
|
|
296
297
|
|
|
297
298
|
## `swaggerhub api:unpublish`
|
|
298
299
|
|
|
@@ -315,7 +316,7 @@ EXAMPLES
|
|
|
315
316
|
$ swaggerhub api:unpublish organization/api/1.0.0
|
|
316
317
|
```
|
|
317
318
|
|
|
318
|
-
_See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
319
|
+
_See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/api/unpublish.js)_
|
|
319
320
|
|
|
320
321
|
## `swaggerhub api:update`
|
|
321
322
|
|
|
@@ -323,8 +324,8 @@ update an API
|
|
|
323
324
|
|
|
324
325
|
```
|
|
325
326
|
USAGE
|
|
326
|
-
$ swaggerhub api:update OWNER/API_NAME/[VERSION] [-
|
|
327
|
-
publish|unpublish] [--setdefault]
|
|
327
|
+
$ swaggerhub api:update OWNER/API_NAME/[VERSION] [-f <value>] [--visibility public|private] [--published
|
|
328
|
+
publish|unpublish] [--setdefault] [-h]
|
|
328
329
|
|
|
329
330
|
ARGUMENTS
|
|
330
331
|
OWNER/API_NAME/[VERSION] API to update on SwaggerHub
|
|
@@ -359,7 +360,7 @@ EXAMPLES
|
|
|
359
360
|
$ swaggerhub api:update organization/api/1.0.0 --visibility=private
|
|
360
361
|
```
|
|
361
362
|
|
|
362
|
-
_See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
363
|
+
_See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/api/update.js)_
|
|
363
364
|
|
|
364
365
|
## `swaggerhub api:validate`
|
|
365
366
|
|
|
@@ -367,7 +368,7 @@ Get validation result for an API version
|
|
|
367
368
|
|
|
368
369
|
```
|
|
369
370
|
USAGE
|
|
370
|
-
$ swaggerhub api:validate OWNER/API_NAME/[VERSION] [-
|
|
371
|
+
$ swaggerhub api:validate OWNER/API_NAME/[VERSION] [-c] [-j] [-h]
|
|
371
372
|
|
|
372
373
|
ARGUMENTS
|
|
373
374
|
OWNER/API_NAME/[VERSION] API to fetch validation errors for from Swaggerhub
|
|
@@ -393,7 +394,38 @@ EXAMPLES
|
|
|
393
394
|
$ swaggerhub api:validate --fail-on-critical --json organization/api
|
|
394
395
|
```
|
|
395
396
|
|
|
396
|
-
_See code: [src/commands/api/validate/index.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
397
|
+
_See code: [src/commands/api/validate/index.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/api/validate/index.js)_
|
|
398
|
+
|
|
399
|
+
## `swaggerhub api:validate:download-rules`
|
|
400
|
+
|
|
401
|
+
Get existing SwaggerHub's organization standardization ruleset.
|
|
402
|
+
|
|
403
|
+
```
|
|
404
|
+
USAGE
|
|
405
|
+
$ swaggerhub api:validate:download-rules OWNER [-s] [-d] [-h]
|
|
406
|
+
|
|
407
|
+
ARGUMENTS
|
|
408
|
+
OWNER Which organization standardization rules to fetch from SwaggerHub
|
|
409
|
+
|
|
410
|
+
FLAGS
|
|
411
|
+
-d, --include-disabled-rules Includes disabled rules in fetched organization's ruleset
|
|
412
|
+
-h, --help Show CLI help.
|
|
413
|
+
-s, --include-system-rules Includes system rules in fetched organization's ruleset
|
|
414
|
+
|
|
415
|
+
DESCRIPTION
|
|
416
|
+
Get existing SwaggerHub's organization standardization ruleset.
|
|
417
|
+
Requires organization name argument. An error will occur if provided organization doesn't exist
|
|
418
|
+
or your account is not permitted to access that organization's settings.
|
|
419
|
+
If the flag `-s` or `--include-system-rules` is used, the returned ruleset will also include SwaggerHub system rules.
|
|
420
|
+
If the flag `-d` or `--include-disabled-rules` is used, the returned ruleset will also include disabled custom rules
|
|
421
|
+
|
|
422
|
+
EXAMPLES
|
|
423
|
+
$ swaggerhub api:validate:download-rules myOrg -s
|
|
424
|
+
|
|
425
|
+
$ swaggerhub api:validate:download-rules myOrg --include-disabled-rules -s
|
|
426
|
+
```
|
|
427
|
+
|
|
428
|
+
_See code: [src/commands/api/validate/download-rules.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/api/validate/download-rules.js)_
|
|
397
429
|
|
|
398
430
|
## `swaggerhub api:validate:local`
|
|
399
431
|
|
|
@@ -401,7 +433,7 @@ Runs a scan against a local API definition using the organization's standardizat
|
|
|
401
433
|
|
|
402
434
|
```
|
|
403
435
|
USAGE
|
|
404
|
-
$ swaggerhub api:validate:local -f <value> -o <value> [-
|
|
436
|
+
$ swaggerhub api:validate:local -f <value> -o <value> [-c] [-j] [-h]
|
|
405
437
|
|
|
406
438
|
FLAGS
|
|
407
439
|
-c, --fail-on-critical Exit with error code 1 if there are critical standardization errors present
|
|
@@ -423,7 +455,7 @@ EXAMPLES
|
|
|
423
455
|
$ swaggerhub api:validate:local --organization myOrg --file ./my-api/json --fail-on-critical --json
|
|
424
456
|
```
|
|
425
457
|
|
|
426
|
-
_See code: [src/commands/api/validate/local.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
458
|
+
_See code: [src/commands/api/validate/local.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/api/validate/local.js)_
|
|
427
459
|
|
|
428
460
|
## `swaggerhub configure`
|
|
429
461
|
|
|
@@ -446,7 +478,7 @@ DESCRIPTION
|
|
|
446
478
|
settings.
|
|
447
479
|
```
|
|
448
480
|
|
|
449
|
-
_See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
481
|
+
_See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/configure.js)_
|
|
450
482
|
|
|
451
483
|
## `swaggerhub domain:create`
|
|
452
484
|
|
|
@@ -454,8 +486,8 @@ creates a new domain / domain version from a YAML/JSON file
|
|
|
454
486
|
|
|
455
487
|
```
|
|
456
488
|
USAGE
|
|
457
|
-
$ swaggerhub domain:create OWNER/DOMAIN_NAME/[VERSION] [
|
|
458
|
-
publish|unpublish -f <value>) [--setdefault ]
|
|
489
|
+
$ swaggerhub domain:create OWNER/DOMAIN_NAME/[VERSION] [--visibility public|private] (--published
|
|
490
|
+
publish|unpublish -f <value>) [--setdefault ] [-h]
|
|
459
491
|
|
|
460
492
|
ARGUMENTS
|
|
461
493
|
OWNER/DOMAIN_NAME/[VERSION] Domain to create on SwaggerHub
|
|
@@ -487,7 +519,7 @@ EXAMPLES
|
|
|
487
519
|
$ swaggerhub domain:create organization/domain/1.0.0 --publish --setdefault --file domain.json
|
|
488
520
|
```
|
|
489
521
|
|
|
490
|
-
_See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
522
|
+
_See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/domain/create.js)_
|
|
491
523
|
|
|
492
524
|
## `swaggerhub domain:delete`
|
|
493
525
|
|
|
@@ -495,7 +527,7 @@ delete a domain or domain version
|
|
|
495
527
|
|
|
496
528
|
```
|
|
497
529
|
USAGE
|
|
498
|
-
$ swaggerhub domain:delete OWNER/DOMAIN_NAME/[VERSION] [-
|
|
530
|
+
$ swaggerhub domain:delete OWNER/DOMAIN_NAME/[VERSION] [-f] [-h]
|
|
499
531
|
|
|
500
532
|
ARGUMENTS
|
|
501
533
|
OWNER/DOMAIN_NAME/[VERSION] Domain to delete on SwaggerHub
|
|
@@ -516,7 +548,7 @@ EXAMPLES
|
|
|
516
548
|
$ swaggerhub domain:delete organization/domain --force
|
|
517
549
|
```
|
|
518
550
|
|
|
519
|
-
_See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
551
|
+
_See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/domain/delete.js)_
|
|
520
552
|
|
|
521
553
|
## `swaggerhub domain:get`
|
|
522
554
|
|
|
@@ -524,7 +556,7 @@ fetches a domain definition
|
|
|
524
556
|
|
|
525
557
|
```
|
|
526
558
|
USAGE
|
|
527
|
-
$ swaggerhub domain:get OWNER/DOMAIN_NAME/[VERSION] [-
|
|
559
|
+
$ swaggerhub domain:get OWNER/DOMAIN_NAME/[VERSION] [-j] [-h]
|
|
528
560
|
|
|
529
561
|
ARGUMENTS
|
|
530
562
|
OWNER/DOMAIN_NAME/[VERSION] Domain to fetch from SwaggerHub
|
|
@@ -545,7 +577,7 @@ EXAMPLES
|
|
|
545
577
|
$ swaggerhub domain:get organization/domain/1.0.0 --json
|
|
546
578
|
```
|
|
547
579
|
|
|
548
|
-
_See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
580
|
+
_See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/domain/get.js)_
|
|
549
581
|
|
|
550
582
|
## `swaggerhub domain:publish`
|
|
551
583
|
|
|
@@ -568,7 +600,7 @@ EXAMPLES
|
|
|
568
600
|
$ swaggerhub domain:publish organization/domain/1.0.0
|
|
569
601
|
```
|
|
570
602
|
|
|
571
|
-
_See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
603
|
+
_See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/domain/publish.js)_
|
|
572
604
|
|
|
573
605
|
## `swaggerhub domain:setdefault`
|
|
574
606
|
|
|
@@ -591,7 +623,7 @@ EXAMPLES
|
|
|
591
623
|
$ swaggerhub domain:setdefault organization/domain/2.0.0
|
|
592
624
|
```
|
|
593
625
|
|
|
594
|
-
_See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
626
|
+
_See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/domain/setdefault.js)_
|
|
595
627
|
|
|
596
628
|
## `swaggerhub domain:unpublish`
|
|
597
629
|
|
|
@@ -614,7 +646,7 @@ EXAMPLES
|
|
|
614
646
|
$ swaggerhub domain:unpublish organization/domain/1.0.0
|
|
615
647
|
```
|
|
616
648
|
|
|
617
|
-
_See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
649
|
+
_See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/domain/unpublish.js)_
|
|
618
650
|
|
|
619
651
|
## `swaggerhub domain:update`
|
|
620
652
|
|
|
@@ -622,8 +654,8 @@ update a domain
|
|
|
622
654
|
|
|
623
655
|
```
|
|
624
656
|
USAGE
|
|
625
|
-
$ swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION] [-
|
|
626
|
-
|
|
657
|
+
$ swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION] [-f <value>] [--visibility public|private] [--published
|
|
658
|
+
publish|unpublish] [--setdefault] [-h]
|
|
627
659
|
|
|
628
660
|
ARGUMENTS
|
|
629
661
|
OWNER/DOMAIN_NAME/[VERSION] Domain to update on SwaggerHub
|
|
@@ -658,7 +690,7 @@ EXAMPLES
|
|
|
658
690
|
$ swaggerhub domain:update organization/domain/1.0.0 --visibility=private
|
|
659
691
|
```
|
|
660
692
|
|
|
661
|
-
_See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
693
|
+
_See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/domain/update.js)_
|
|
662
694
|
|
|
663
695
|
## `swaggerhub help`
|
|
664
696
|
|
|
@@ -678,7 +710,7 @@ DESCRIPTION
|
|
|
678
710
|
Display help for swaggerhub.
|
|
679
711
|
```
|
|
680
712
|
|
|
681
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/
|
|
713
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.3/src/commands/help.ts)_
|
|
682
714
|
|
|
683
715
|
## `swaggerhub integration:create`
|
|
684
716
|
|
|
@@ -706,7 +738,7 @@ EXAMPLES
|
|
|
706
738
|
$ swaggerhub integration:create organization/api/1.0.0 --file config.json
|
|
707
739
|
```
|
|
708
740
|
|
|
709
|
-
_See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
741
|
+
_See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/integration/create.js)_
|
|
710
742
|
|
|
711
743
|
## `swaggerhub integration:delete`
|
|
712
744
|
|
|
@@ -729,7 +761,7 @@ EXAMPLES
|
|
|
729
761
|
$ swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
730
762
|
```
|
|
731
763
|
|
|
732
|
-
_See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
764
|
+
_See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/integration/delete.js)_
|
|
733
765
|
|
|
734
766
|
## `swaggerhub integration:execute`
|
|
735
767
|
|
|
@@ -752,7 +784,7 @@ EXAMPLES
|
|
|
752
784
|
$ swaggerhub integration:execute organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
753
785
|
```
|
|
754
786
|
|
|
755
|
-
_See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
787
|
+
_See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/integration/execute.js)_
|
|
756
788
|
|
|
757
789
|
## `swaggerhub integration:get`
|
|
758
790
|
|
|
@@ -775,7 +807,7 @@ EXAMPLES
|
|
|
775
807
|
$ swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
776
808
|
```
|
|
777
809
|
|
|
778
|
-
_See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
810
|
+
_See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/integration/get.js)_
|
|
779
811
|
|
|
780
812
|
## `swaggerhub integration:list`
|
|
781
813
|
|
|
@@ -798,7 +830,7 @@ EXAMPLES
|
|
|
798
830
|
$ swaggerhub integration:list organization/api/1.0.0
|
|
799
831
|
```
|
|
800
832
|
|
|
801
|
-
_See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
833
|
+
_See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/integration/list.js)_
|
|
802
834
|
|
|
803
835
|
## `swaggerhub integration:update`
|
|
804
836
|
|
|
@@ -822,7 +854,7 @@ EXAMPLES
|
|
|
822
854
|
$ swaggerhub integration:update organization/api/1.0.0/503c2db6-448a-4678-abcd-0123456789abc --file config.json
|
|
823
855
|
```
|
|
824
856
|
|
|
825
|
-
_See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
857
|
+
_See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/integration/update.js)_
|
|
826
858
|
|
|
827
859
|
## `swaggerhub plugins`
|
|
828
860
|
|
|
@@ -845,7 +877,7 @@ EXAMPLES
|
|
|
845
877
|
$ swaggerhub plugins
|
|
846
878
|
```
|
|
847
879
|
|
|
848
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1
|
|
880
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.1/src/commands/plugins/index.ts)_
|
|
849
881
|
|
|
850
882
|
## `swaggerhub plugins:install`
|
|
851
883
|
|
|
@@ -910,7 +942,7 @@ EXAMPLES
|
|
|
910
942
|
$ swaggerhub plugins:inspect myplugin
|
|
911
943
|
```
|
|
912
944
|
|
|
913
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1
|
|
945
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.1/src/commands/plugins/inspect.ts)_
|
|
914
946
|
|
|
915
947
|
## `swaggerhub plugins:install`
|
|
916
948
|
|
|
@@ -950,7 +982,7 @@ EXAMPLES
|
|
|
950
982
|
$ swaggerhub plugins:install someuser/someplugin
|
|
951
983
|
```
|
|
952
984
|
|
|
953
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1
|
|
985
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.1/src/commands/plugins/install.ts)_
|
|
954
986
|
|
|
955
987
|
## `swaggerhub plugins:link`
|
|
956
988
|
|
|
@@ -964,8 +996,9 @@ ARGUMENTS
|
|
|
964
996
|
PATH [default: .] path to plugin
|
|
965
997
|
|
|
966
998
|
FLAGS
|
|
967
|
-
-h, --help
|
|
999
|
+
-h, --help Show CLI help.
|
|
968
1000
|
-v, --verbose
|
|
1001
|
+
--[no-]install Install dependencies after linking the plugin.
|
|
969
1002
|
|
|
970
1003
|
DESCRIPTION
|
|
971
1004
|
Links a plugin into the CLI for development.
|
|
@@ -979,7 +1012,7 @@ EXAMPLES
|
|
|
979
1012
|
$ swaggerhub plugins:link myplugin
|
|
980
1013
|
```
|
|
981
1014
|
|
|
982
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1
|
|
1015
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.1/src/commands/plugins/link.ts)_
|
|
983
1016
|
|
|
984
1017
|
## `swaggerhub plugins:uninstall`
|
|
985
1018
|
|
|
@@ -1027,7 +1060,7 @@ ALIASES
|
|
|
1027
1060
|
$ swaggerhub plugins:remove
|
|
1028
1061
|
```
|
|
1029
1062
|
|
|
1030
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1
|
|
1063
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.1/src/commands/plugins/uninstall.ts)_
|
|
1031
1064
|
|
|
1032
1065
|
## `swaggerhub plugins:uninstall`
|
|
1033
1066
|
|
|
@@ -1068,7 +1101,7 @@ DESCRIPTION
|
|
|
1068
1101
|
Update installed plugins.
|
|
1069
1102
|
```
|
|
1070
1103
|
|
|
1071
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1
|
|
1104
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.1/src/commands/plugins/update.ts)_
|
|
1072
1105
|
|
|
1073
1106
|
## `swaggerhub project:api:add`
|
|
1074
1107
|
|
|
@@ -1092,7 +1125,7 @@ EXAMPLES
|
|
|
1092
1125
|
$ swaggerhub project:api:add organization/project_name my_api
|
|
1093
1126
|
```
|
|
1094
1127
|
|
|
1095
|
-
_See code: [src/commands/project/api/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1128
|
+
_See code: [src/commands/project/api/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/project/api/add.js)_
|
|
1096
1129
|
|
|
1097
1130
|
## `swaggerhub project:api:remove`
|
|
1098
1131
|
|
|
@@ -1116,7 +1149,7 @@ EXAMPLES
|
|
|
1116
1149
|
$ swaggerhub project:api:remove organization/project_name my_api
|
|
1117
1150
|
```
|
|
1118
1151
|
|
|
1119
|
-
_See code: [src/commands/project/api/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1152
|
+
_See code: [src/commands/project/api/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/project/api/remove.js)_
|
|
1120
1153
|
|
|
1121
1154
|
## `swaggerhub project:create`
|
|
1122
1155
|
|
|
@@ -1124,7 +1157,7 @@ Creates a new project in SwaggerHub.
|
|
|
1124
1157
|
|
|
1125
1158
|
```
|
|
1126
1159
|
USAGE
|
|
1127
|
-
$ swaggerhub project:create OWNER/PROJECT_NAME [
|
|
1160
|
+
$ swaggerhub project:create OWNER/PROJECT_NAME [--description <value>] [-a <value>] [-d <value>] [-h]
|
|
1128
1161
|
|
|
1129
1162
|
ARGUMENTS
|
|
1130
1163
|
OWNER/PROJECT_NAME The new project to create on Swaggerhub
|
|
@@ -1152,7 +1185,7 @@ EXAMPLES
|
|
|
1152
1185
|
$ swaggerhub project:create organization/new_project_name -a "testapi1" -d "testdomain3" --description "description"
|
|
1153
1186
|
```
|
|
1154
1187
|
|
|
1155
|
-
_See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1188
|
+
_See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/project/create.js)_
|
|
1156
1189
|
|
|
1157
1190
|
## `swaggerhub project:delete`
|
|
1158
1191
|
|
|
@@ -1175,7 +1208,7 @@ EXAMPLES
|
|
|
1175
1208
|
$ swaggerhub project:delete organization/project_name
|
|
1176
1209
|
```
|
|
1177
1210
|
|
|
1178
|
-
_See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1211
|
+
_See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/project/delete.js)_
|
|
1179
1212
|
|
|
1180
1213
|
## `swaggerhub project:domain:add`
|
|
1181
1214
|
|
|
@@ -1199,7 +1232,7 @@ EXAMPLES
|
|
|
1199
1232
|
$ swaggerhub project:domain:add organization/project_name my_domain
|
|
1200
1233
|
```
|
|
1201
1234
|
|
|
1202
|
-
_See code: [src/commands/project/domain/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1235
|
+
_See code: [src/commands/project/domain/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/project/domain/add.js)_
|
|
1203
1236
|
|
|
1204
1237
|
## `swaggerhub project:domain:remove`
|
|
1205
1238
|
|
|
@@ -1223,7 +1256,7 @@ EXAMPLES
|
|
|
1223
1256
|
$ swaggerhub project:domain:remove organization/project_name my_domain
|
|
1224
1257
|
```
|
|
1225
1258
|
|
|
1226
|
-
_See code: [src/commands/project/domain/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1259
|
+
_See code: [src/commands/project/domain/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/project/domain/remove.js)_
|
|
1227
1260
|
|
|
1228
1261
|
## `swaggerhub project:get`
|
|
1229
1262
|
|
|
@@ -1246,7 +1279,7 @@ EXAMPLES
|
|
|
1246
1279
|
$ swaggerhub project:get organization/project_name
|
|
1247
1280
|
```
|
|
1248
1281
|
|
|
1249
|
-
_See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1282
|
+
_See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/project/get.js)_
|
|
1250
1283
|
|
|
1251
1284
|
## `swaggerhub project:list`
|
|
1252
1285
|
|
|
@@ -1271,7 +1304,7 @@ EXAMPLES
|
|
|
1271
1304
|
$ swaggerhub project:list organization
|
|
1272
1305
|
```
|
|
1273
1306
|
|
|
1274
|
-
_See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1307
|
+
_See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/project/list.js)_
|
|
1275
1308
|
|
|
1276
1309
|
## `swaggerhub project:member:list`
|
|
1277
1310
|
|
|
@@ -1294,7 +1327,7 @@ EXAMPLES
|
|
|
1294
1327
|
$ swaggerhub project:member:list organisation/project_name
|
|
1295
1328
|
```
|
|
1296
1329
|
|
|
1297
|
-
_See code: [src/commands/project/member/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1330
|
+
_See code: [src/commands/project/member/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.9.0/src/commands/project/member/list.js)_
|
|
1298
1331
|
<!-- commandsstop -->
|
|
1299
1332
|
|
|
1300
1333
|
# Plugins
|