swaggerhub-cli 0.15.0 → 0.16.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 +150 -39
- package/oclif.manifest.json +805 -634
- package/package.json +9 -6
- package/skills/swaggerhub-cli/SKILL.md +43 -0
- package/src/commands/api/comment/list.js +91 -0
- package/src/commands/api/fork.js +75 -0
- package/src/commands/domain/fork.js +75 -0
- package/src/config/index.js +11 -3
- package/src/hooks/setup-config.js +5 -4
- package/src/template-strings/info.js +4 -0
package/README.md
CHANGED
|
@@ -11,6 +11,7 @@ The Swagger CLI enables teams to build automation and workflows around Swagger.
|
|
|
11
11
|
* [Setup](#setup)
|
|
12
12
|
* [Using a proxy](#using-a-proxy)
|
|
13
13
|
* [Additional configuration for Swagger Studio On-Premise](#additional-configuration-for-swagger-studio-on-premise)
|
|
14
|
+
* [Using with AI agents](#using-with-ai-agents)
|
|
14
15
|
* [Usage](#usage)
|
|
15
16
|
* [Commands](#commands)
|
|
16
17
|
* [Plugins](#plugins)
|
|
@@ -105,6 +106,21 @@ set NODE_EXTRA_CA_CERTS=C:/Work/extra-ca-certs.pem
|
|
|
105
106
|
set NODE_EXTRA_CA_CERTS=%USERPROFILE%\extra-ca-certs.pem
|
|
106
107
|
```
|
|
107
108
|
|
|
109
|
+
# Using with AI agents
|
|
110
|
+
|
|
111
|
+
The repository ships an [agent skill](skills/swaggerhub-cli/SKILL.md) that teaches AI coding agents (Claude Code, Cursor, Codex and others) how to use the `swaggerhub` CLI. It can be installed with the [`skills`](https://www.npmjs.com/package/skills) CLI.
|
|
112
|
+
|
|
113
|
+
The skill only provides instructions. The agent still needs the CLI installed (see [Installation](#installation)) and `SWAGGERHUB_API_KEY` set (see [Setup](#setup)).
|
|
114
|
+
|
|
115
|
+
- List the skills available in this repository without installing: `npx skills add SmartBear/swaggerhub-cli --list`
|
|
116
|
+
- Install into the current project: `npx skills add SmartBear/swaggerhub-cli`
|
|
117
|
+
- Install only this skill, globally, for a specific agent: `npx skills add SmartBear/swaggerhub-cli --skill swaggerhub-cli -g -a claude-code`
|
|
118
|
+
- See what is installed, check for updates, update, remove: `npx skills list`, `npx skills check`, `npx skills update`, `npx skills remove swaggerhub-cli`
|
|
119
|
+
|
|
120
|
+
Once installed, the agent loads the skill automatically when a task matches its description, for example "fetch the definition of my API from Swagger" or "publish this API version". You can also ask for it by name, e.g. "use the swaggerhub-cli skill to ...". In Claude Code it is also available as `/swaggerhub-cli`.
|
|
121
|
+
|
|
122
|
+
Run `npx skills add --help` for all options. Skills are installed from the repository's default branch, so re-run `npx skills update` after a new CLI release to pick up changes.
|
|
123
|
+
|
|
108
124
|
# Usage
|
|
109
125
|
```sh-session
|
|
110
126
|
$ swaggerhub COMMAND
|
|
@@ -119,8 +135,10 @@ USAGE
|
|
|
119
135
|
# Commands
|
|
120
136
|
<!-- commands -->
|
|
121
137
|
* [`swaggerhub api:clone OWNER/API_NAME/VERSION NEW_VERSION`](#swaggerhub-apiclone)
|
|
138
|
+
* [`swaggerhub api:comment:list OWNER/API_NAME/VERSION`](#swaggerhub-apicommentlist)
|
|
122
139
|
* [`swaggerhub api:create OWNER/API_NAME/[VERSION]`](#swaggerhub-apicreate)
|
|
123
140
|
* [`swaggerhub api:delete OWNER/API_NAME/[VERSION]`](#swaggerhub-apidelete)
|
|
141
|
+
* [`swaggerhub api:fork OWNER/API_NAME/VERSION NEW_OWNER/NEW_API_NAME/NEW_VERSION`](#swaggerhub-apifork)
|
|
124
142
|
* [`swaggerhub api:get OWNER/API_NAME/[VERSION]`](#swaggerhub-apiget)
|
|
125
143
|
* [`swaggerhub api:publish OWNER/API_NAME/VERSION`](#swaggerhub-apipublish)
|
|
126
144
|
* [`swaggerhub api:rename OWNER/API_NAME API_NEW_NAME`](#swaggerhub-apirename)
|
|
@@ -134,6 +152,7 @@ USAGE
|
|
|
134
152
|
* [`swaggerhub domain:clone OWNER/DOMAIN_NAME/VERSION NEW_VERSION`](#swaggerhub-domainclone)
|
|
135
153
|
* [`swaggerhub domain:create OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domaincreate)
|
|
136
154
|
* [`swaggerhub domain:delete OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domaindelete)
|
|
155
|
+
* [`swaggerhub domain:fork OWNER/DOMAIN_NAME/VERSION NEW_OWNER/NEW_DOMAIN_NAME/NEW_VERSION`](#swaggerhub-domainfork)
|
|
137
156
|
* [`swaggerhub domain:get OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domainget)
|
|
138
157
|
* [`swaggerhub domain:publish OWNER/DOMAIN_NAME/VERSION`](#swaggerhub-domainpublish)
|
|
139
158
|
* [`swaggerhub domain:rename OWNER/DOMAIN_NAME DOMAIN_NEW_NAME`](#swaggerhub-domainrename)
|
|
@@ -195,7 +214,33 @@ EXAMPLES
|
|
|
195
214
|
$ swaggerhub api:clone organization/api/1.0.0 1.0.1 --visibility public
|
|
196
215
|
```
|
|
197
216
|
|
|
198
|
-
_See code: [src/commands/api/clone.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
217
|
+
_See code: [src/commands/api/clone.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/clone.js)_
|
|
218
|
+
|
|
219
|
+
## `swaggerhub api:comment:list`
|
|
220
|
+
|
|
221
|
+
list the comments of an API version
|
|
222
|
+
|
|
223
|
+
```
|
|
224
|
+
USAGE
|
|
225
|
+
$ swaggerhub api:comment:list OWNER/API_NAME/VERSION [-j] [-h]
|
|
226
|
+
|
|
227
|
+
ARGUMENTS
|
|
228
|
+
OWNER/API_NAME/VERSION API version to list comments for
|
|
229
|
+
|
|
230
|
+
FLAGS
|
|
231
|
+
-h, --help Show CLI help.
|
|
232
|
+
-j, --json prints the comments, including replies and ranges, as JSON
|
|
233
|
+
|
|
234
|
+
DESCRIPTION
|
|
235
|
+
list the comments of an API version
|
|
236
|
+
|
|
237
|
+
EXAMPLES
|
|
238
|
+
$ swaggerhub api:comment:list organization/api/1.0.0
|
|
239
|
+
|
|
240
|
+
$ swaggerhub api:comment:list organization/api/1.0.0 --json
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
_See code: [src/commands/api/comment/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/comment/list.js)_
|
|
199
244
|
|
|
200
245
|
## `swaggerhub api:create`
|
|
201
246
|
|
|
@@ -236,7 +281,7 @@ EXAMPLES
|
|
|
236
281
|
$ swaggerhub api:create organization/api/1.0.0 --published=publish --setdefault --file api.json
|
|
237
282
|
```
|
|
238
283
|
|
|
239
|
-
_See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
284
|
+
_See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/create.js)_
|
|
240
285
|
|
|
241
286
|
## `swaggerhub api:delete`
|
|
242
287
|
|
|
@@ -265,7 +310,40 @@ EXAMPLES
|
|
|
265
310
|
$ swaggerhub api:delete organization/api --force
|
|
266
311
|
```
|
|
267
312
|
|
|
268
|
-
_See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
313
|
+
_See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/delete.js)_
|
|
314
|
+
|
|
315
|
+
## `swaggerhub api:fork`
|
|
316
|
+
|
|
317
|
+
fork an API version
|
|
318
|
+
|
|
319
|
+
```
|
|
320
|
+
USAGE
|
|
321
|
+
$ swaggerhub api:fork OWNER/API_NAME/VERSION NEW_OWNER/NEW_API_NAME/NEW_VERSION [--project <value>]
|
|
322
|
+
[--visibility public|private] [-h]
|
|
323
|
+
|
|
324
|
+
ARGUMENTS
|
|
325
|
+
OWNER/API_NAME/VERSION API version to fork
|
|
326
|
+
NEW_OWNER/NEW_API_NAME/NEW_VERSION Owner, name and version of the fork. An existing API name creates a new version of
|
|
327
|
+
it.
|
|
328
|
+
|
|
329
|
+
FLAGS
|
|
330
|
+
-h, --help Show CLI help.
|
|
331
|
+
--project=<value> existing project of the target organization to add the fork to
|
|
332
|
+
--visibility=<option> visibility of the fork (defaults to the visibility of the source version)
|
|
333
|
+
<options: public|private>
|
|
334
|
+
|
|
335
|
+
DESCRIPTION
|
|
336
|
+
fork an API version
|
|
337
|
+
The fork can be created as a new API, or as a new version of another existing API.
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
EXAMPLES
|
|
341
|
+
$ swaggerhub api:fork organization/api/1.0.0 myorg/api-fork/1.0.0
|
|
342
|
+
|
|
343
|
+
$ swaggerhub api:fork organization/api/1.0.0 myorg/api-fork/1.0.0 --project my-project --visibility private
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
_See code: [src/commands/api/fork.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/fork.js)_
|
|
269
347
|
|
|
270
348
|
## `swaggerhub api:get`
|
|
271
349
|
|
|
@@ -295,7 +373,7 @@ EXAMPLES
|
|
|
295
373
|
$ swaggerhub api:get organization/api/1.0.0 --json
|
|
296
374
|
```
|
|
297
375
|
|
|
298
|
-
_See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
376
|
+
_See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/get.js)_
|
|
299
377
|
|
|
300
378
|
## `swaggerhub api:publish`
|
|
301
379
|
|
|
@@ -321,7 +399,7 @@ EXAMPLES
|
|
|
321
399
|
$ swaggerhub api:publish organization/api/1.0.0 --force
|
|
322
400
|
```
|
|
323
401
|
|
|
324
|
-
_See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
402
|
+
_See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/publish.js)_
|
|
325
403
|
|
|
326
404
|
## `swaggerhub api:rename`
|
|
327
405
|
|
|
@@ -345,7 +423,7 @@ EXAMPLES
|
|
|
345
423
|
$ swaggerhub api:rename organization/apiOldName apiNewName
|
|
346
424
|
```
|
|
347
425
|
|
|
348
|
-
_See code: [src/commands/api/rename.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
426
|
+
_See code: [src/commands/api/rename.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/rename.js)_
|
|
349
427
|
|
|
350
428
|
## `swaggerhub api:setdefault`
|
|
351
429
|
|
|
@@ -368,7 +446,7 @@ EXAMPLES
|
|
|
368
446
|
$ swaggerhub api:setdefault organization/api/2.0.0
|
|
369
447
|
```
|
|
370
448
|
|
|
371
|
-
_See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
449
|
+
_See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/setdefault.js)_
|
|
372
450
|
|
|
373
451
|
## `swaggerhub api:unpublish`
|
|
374
452
|
|
|
@@ -391,7 +469,7 @@ EXAMPLES
|
|
|
391
469
|
$ swaggerhub api:unpublish organization/api/1.0.0
|
|
392
470
|
```
|
|
393
471
|
|
|
394
|
-
_See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
472
|
+
_See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/unpublish.js)_
|
|
395
473
|
|
|
396
474
|
## `swaggerhub api:update`
|
|
397
475
|
|
|
@@ -435,7 +513,7 @@ EXAMPLES
|
|
|
435
513
|
$ swaggerhub api:update organization/api/1.0.0 --visibility=private
|
|
436
514
|
```
|
|
437
515
|
|
|
438
|
-
_See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
516
|
+
_See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/update.js)_
|
|
439
517
|
|
|
440
518
|
## `swaggerhub api:validate`
|
|
441
519
|
|
|
@@ -469,7 +547,7 @@ EXAMPLES
|
|
|
469
547
|
$ swaggerhub api:validate --fail-on-critical --json organization/api
|
|
470
548
|
```
|
|
471
549
|
|
|
472
|
-
_See code: [src/commands/api/validate/index.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
550
|
+
_See code: [src/commands/api/validate/index.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/validate/index.js)_
|
|
473
551
|
|
|
474
552
|
## `swaggerhub api:validate:download-rules`
|
|
475
553
|
|
|
@@ -500,7 +578,7 @@ EXAMPLES
|
|
|
500
578
|
$ swaggerhub api:validate:download-rules myOrg --include-disabled-rules -s
|
|
501
579
|
```
|
|
502
580
|
|
|
503
|
-
_See code: [src/commands/api/validate/download-rules.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
581
|
+
_See code: [src/commands/api/validate/download-rules.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/validate/download-rules.js)_
|
|
504
582
|
|
|
505
583
|
## `swaggerhub api:validate:local`
|
|
506
584
|
|
|
@@ -530,7 +608,7 @@ EXAMPLES
|
|
|
530
608
|
$ swaggerhub api:validate:local --organization myOrg --file ./my-api.json --fail-on-critical --json
|
|
531
609
|
```
|
|
532
610
|
|
|
533
|
-
_See code: [src/commands/api/validate/local.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
611
|
+
_See code: [src/commands/api/validate/local.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/api/validate/local.js)_
|
|
534
612
|
|
|
535
613
|
## `swaggerhub configure`
|
|
536
614
|
|
|
@@ -553,7 +631,7 @@ DESCRIPTION
|
|
|
553
631
|
settings.
|
|
554
632
|
```
|
|
555
633
|
|
|
556
|
-
_See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
634
|
+
_See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/configure.js)_
|
|
557
635
|
|
|
558
636
|
## `swaggerhub domain:clone`
|
|
559
637
|
|
|
@@ -581,7 +659,7 @@ EXAMPLES
|
|
|
581
659
|
$ swaggerhub domain:clone organization/domain/1.0.0 1.0.1 --visibility public
|
|
582
660
|
```
|
|
583
661
|
|
|
584
|
-
_See code: [src/commands/domain/clone.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
662
|
+
_See code: [src/commands/domain/clone.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/domain/clone.js)_
|
|
585
663
|
|
|
586
664
|
## `swaggerhub domain:create`
|
|
587
665
|
|
|
@@ -622,7 +700,7 @@ EXAMPLES
|
|
|
622
700
|
$ swaggerhub domain:create organization/domain/1.0.0 --published=publish --setdefault --file domain.json
|
|
623
701
|
```
|
|
624
702
|
|
|
625
|
-
_See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
703
|
+
_See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/domain/create.js)_
|
|
626
704
|
|
|
627
705
|
## `swaggerhub domain:delete`
|
|
628
706
|
|
|
@@ -651,7 +729,40 @@ EXAMPLES
|
|
|
651
729
|
$ swaggerhub domain:delete organization/domain --force
|
|
652
730
|
```
|
|
653
731
|
|
|
654
|
-
_See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
732
|
+
_See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/domain/delete.js)_
|
|
733
|
+
|
|
734
|
+
## `swaggerhub domain:fork`
|
|
735
|
+
|
|
736
|
+
fork a domain version
|
|
737
|
+
|
|
738
|
+
```
|
|
739
|
+
USAGE
|
|
740
|
+
$ swaggerhub domain:fork OWNER/DOMAIN_NAME/VERSION NEW_OWNER/NEW_DOMAIN_NAME/NEW_VERSION [--project <value>]
|
|
741
|
+
[--visibility public|private] [-h]
|
|
742
|
+
|
|
743
|
+
ARGUMENTS
|
|
744
|
+
OWNER/DOMAIN_NAME/VERSION Domain version to fork
|
|
745
|
+
NEW_OWNER/NEW_DOMAIN_NAME/NEW_VERSION Owner, name and version of the fork. An existing domain name creates a new
|
|
746
|
+
version of it.
|
|
747
|
+
|
|
748
|
+
FLAGS
|
|
749
|
+
-h, --help Show CLI help.
|
|
750
|
+
--project=<value> existing project of the target organization to add the fork to
|
|
751
|
+
--visibility=<option> visibility of the fork (defaults to the visibility of the source version)
|
|
752
|
+
<options: public|private>
|
|
753
|
+
|
|
754
|
+
DESCRIPTION
|
|
755
|
+
fork a domain version
|
|
756
|
+
The fork can be created as a new domain, or as a new version of another existing domain.
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
EXAMPLES
|
|
760
|
+
$ swaggerhub domain:fork organization/domain/1.0.0 myorg/domain-fork/1.0.0
|
|
761
|
+
|
|
762
|
+
$ swaggerhub domain:fork organization/domain/1.0.0 myorg/domain-fork/1.0.0 --project my-project --visibility private
|
|
763
|
+
```
|
|
764
|
+
|
|
765
|
+
_See code: [src/commands/domain/fork.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/domain/fork.js)_
|
|
655
766
|
|
|
656
767
|
## `swaggerhub domain:get`
|
|
657
768
|
|
|
@@ -680,7 +791,7 @@ EXAMPLES
|
|
|
680
791
|
$ swaggerhub domain:get organization/domain/1.0.0 --json
|
|
681
792
|
```
|
|
682
793
|
|
|
683
|
-
_See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
794
|
+
_See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/domain/get.js)_
|
|
684
795
|
|
|
685
796
|
## `swaggerhub domain:publish`
|
|
686
797
|
|
|
@@ -706,7 +817,7 @@ EXAMPLES
|
|
|
706
817
|
$ swaggerhub domain:publish organization/domain/1.0.0 --force
|
|
707
818
|
```
|
|
708
819
|
|
|
709
|
-
_See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
820
|
+
_See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/domain/publish.js)_
|
|
710
821
|
|
|
711
822
|
## `swaggerhub domain:rename`
|
|
712
823
|
|
|
@@ -733,7 +844,7 @@ EXAMPLES
|
|
|
733
844
|
$ swaggerhub domain:rename organization/domainOldName domainNewName --force
|
|
734
845
|
```
|
|
735
846
|
|
|
736
|
-
_See code: [src/commands/domain/rename.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
847
|
+
_See code: [src/commands/domain/rename.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/domain/rename.js)_
|
|
737
848
|
|
|
738
849
|
## `swaggerhub domain:setdefault`
|
|
739
850
|
|
|
@@ -756,7 +867,7 @@ EXAMPLES
|
|
|
756
867
|
$ swaggerhub domain:setdefault organization/domain/2.0.0
|
|
757
868
|
```
|
|
758
869
|
|
|
759
|
-
_See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
870
|
+
_See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/domain/setdefault.js)_
|
|
760
871
|
|
|
761
872
|
## `swaggerhub domain:unpublish`
|
|
762
873
|
|
|
@@ -779,7 +890,7 @@ EXAMPLES
|
|
|
779
890
|
$ swaggerhub domain:unpublish organization/domain/1.0.0
|
|
780
891
|
```
|
|
781
892
|
|
|
782
|
-
_See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
893
|
+
_See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/domain/unpublish.js)_
|
|
783
894
|
|
|
784
895
|
## `swaggerhub domain:update`
|
|
785
896
|
|
|
@@ -823,7 +934,7 @@ EXAMPLES
|
|
|
823
934
|
$ swaggerhub domain:update organization/domain/1.0.0 --visibility=private
|
|
824
935
|
```
|
|
825
936
|
|
|
826
|
-
_See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
937
|
+
_See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/domain/update.js)_
|
|
827
938
|
|
|
828
939
|
## `swaggerhub help`
|
|
829
940
|
|
|
@@ -871,7 +982,7 @@ EXAMPLES
|
|
|
871
982
|
$ swaggerhub integration:create organization/api/1.0.0 --file config.json
|
|
872
983
|
```
|
|
873
984
|
|
|
874
|
-
_See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
985
|
+
_See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/integration/create.js)_
|
|
875
986
|
|
|
876
987
|
## `swaggerhub integration:delete`
|
|
877
988
|
|
|
@@ -894,7 +1005,7 @@ EXAMPLES
|
|
|
894
1005
|
$ swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
895
1006
|
```
|
|
896
1007
|
|
|
897
|
-
_See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1008
|
+
_See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/integration/delete.js)_
|
|
898
1009
|
|
|
899
1010
|
## `swaggerhub integration:execute`
|
|
900
1011
|
|
|
@@ -917,7 +1028,7 @@ EXAMPLES
|
|
|
917
1028
|
$ swaggerhub integration:execute organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
918
1029
|
```
|
|
919
1030
|
|
|
920
|
-
_See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1031
|
+
_See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/integration/execute.js)_
|
|
921
1032
|
|
|
922
1033
|
## `swaggerhub integration:get`
|
|
923
1034
|
|
|
@@ -940,7 +1051,7 @@ EXAMPLES
|
|
|
940
1051
|
$ swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
941
1052
|
```
|
|
942
1053
|
|
|
943
|
-
_See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1054
|
+
_See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/integration/get.js)_
|
|
944
1055
|
|
|
945
1056
|
## `swaggerhub integration:list`
|
|
946
1057
|
|
|
@@ -963,7 +1074,7 @@ EXAMPLES
|
|
|
963
1074
|
$ swaggerhub integration:list organization/api/1.0.0
|
|
964
1075
|
```
|
|
965
1076
|
|
|
966
|
-
_See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1077
|
+
_See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/integration/list.js)_
|
|
967
1078
|
|
|
968
1079
|
## `swaggerhub integration:update`
|
|
969
1080
|
|
|
@@ -987,7 +1098,7 @@ EXAMPLES
|
|
|
987
1098
|
$ swaggerhub integration:update organization/api/1.0.0/503c2db6-448a-4678-abcd-0123456789abc --file config.json
|
|
988
1099
|
```
|
|
989
1100
|
|
|
990
|
-
_See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1101
|
+
_See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/integration/update.js)_
|
|
991
1102
|
|
|
992
1103
|
## `swaggerhub plugins`
|
|
993
1104
|
|
|
@@ -1301,7 +1412,7 @@ EXAMPLES
|
|
|
1301
1412
|
$ swaggerhub project:api:add organization/project_name my_api
|
|
1302
1413
|
```
|
|
1303
1414
|
|
|
1304
|
-
_See code: [src/commands/project/api/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1415
|
+
_See code: [src/commands/project/api/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/project/api/add.js)_
|
|
1305
1416
|
|
|
1306
1417
|
## `swaggerhub project:api:remove`
|
|
1307
1418
|
|
|
@@ -1325,7 +1436,7 @@ EXAMPLES
|
|
|
1325
1436
|
$ swaggerhub project:api:remove organization/project_name my_api
|
|
1326
1437
|
```
|
|
1327
1438
|
|
|
1328
|
-
_See code: [src/commands/project/api/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1439
|
+
_See code: [src/commands/project/api/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/project/api/remove.js)_
|
|
1329
1440
|
|
|
1330
1441
|
## `swaggerhub project:create`
|
|
1331
1442
|
|
|
@@ -1361,7 +1472,7 @@ EXAMPLES
|
|
|
1361
1472
|
$ swaggerhub project:create organization/new_project_name -a "testapi1" -d "testdomain3" --description "description"
|
|
1362
1473
|
```
|
|
1363
1474
|
|
|
1364
|
-
_See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1475
|
+
_See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/project/create.js)_
|
|
1365
1476
|
|
|
1366
1477
|
## `swaggerhub project:delete`
|
|
1367
1478
|
|
|
@@ -1384,7 +1495,7 @@ EXAMPLES
|
|
|
1384
1495
|
$ swaggerhub project:delete organization/project_name
|
|
1385
1496
|
```
|
|
1386
1497
|
|
|
1387
|
-
_See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1498
|
+
_See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/project/delete.js)_
|
|
1388
1499
|
|
|
1389
1500
|
## `swaggerhub project:domain:add`
|
|
1390
1501
|
|
|
@@ -1408,7 +1519,7 @@ EXAMPLES
|
|
|
1408
1519
|
$ swaggerhub project:domain:add organization/project_name my_domain
|
|
1409
1520
|
```
|
|
1410
1521
|
|
|
1411
|
-
_See code: [src/commands/project/domain/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1522
|
+
_See code: [src/commands/project/domain/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/project/domain/add.js)_
|
|
1412
1523
|
|
|
1413
1524
|
## `swaggerhub project:domain:remove`
|
|
1414
1525
|
|
|
@@ -1432,7 +1543,7 @@ EXAMPLES
|
|
|
1432
1543
|
$ swaggerhub project:domain:remove organization/project_name my_domain
|
|
1433
1544
|
```
|
|
1434
1545
|
|
|
1435
|
-
_See code: [src/commands/project/domain/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1546
|
+
_See code: [src/commands/project/domain/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/project/domain/remove.js)_
|
|
1436
1547
|
|
|
1437
1548
|
## `swaggerhub project:get`
|
|
1438
1549
|
|
|
@@ -1455,7 +1566,7 @@ EXAMPLES
|
|
|
1455
1566
|
$ swaggerhub project:get organization/project_name
|
|
1456
1567
|
```
|
|
1457
1568
|
|
|
1458
|
-
_See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1569
|
+
_See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/project/get.js)_
|
|
1459
1570
|
|
|
1460
1571
|
## `swaggerhub project:list`
|
|
1461
1572
|
|
|
@@ -1488,7 +1599,7 @@ EXAMPLES
|
|
|
1488
1599
|
$ swaggerhub project:list organization --page 2 --limit 20
|
|
1489
1600
|
```
|
|
1490
1601
|
|
|
1491
|
-
_See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1602
|
+
_See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/project/list.js)_
|
|
1492
1603
|
|
|
1493
1604
|
## `swaggerhub project:member:list`
|
|
1494
1605
|
|
|
@@ -1511,7 +1622,7 @@ EXAMPLES
|
|
|
1511
1622
|
$ swaggerhub project:member:list organization/project_name
|
|
1512
1623
|
```
|
|
1513
1624
|
|
|
1514
|
-
_See code: [src/commands/project/member/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1625
|
+
_See code: [src/commands/project/member/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/project/member/list.js)_
|
|
1515
1626
|
|
|
1516
1627
|
## `swaggerhub spectral:download`
|
|
1517
1628
|
|
|
@@ -1535,7 +1646,7 @@ EXAMPLES
|
|
|
1535
1646
|
$ swaggerhub spectral:download my_organization/my_api_ruleset rules/
|
|
1536
1647
|
```
|
|
1537
1648
|
|
|
1538
|
-
_See code: [src/commands/spectral/download.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1649
|
+
_See code: [src/commands/spectral/download.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/spectral/download.js)_
|
|
1539
1650
|
|
|
1540
1651
|
## `swaggerhub spectral:upload`
|
|
1541
1652
|
|
|
@@ -1559,7 +1670,7 @@ EXAMPLES
|
|
|
1559
1670
|
$ swaggerhub spectral:upload my_organization/my_api_ruleset rules/
|
|
1560
1671
|
```
|
|
1561
1672
|
|
|
1562
|
-
_See code: [src/commands/spectral/upload.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1673
|
+
_See code: [src/commands/spectral/upload.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.16.0/src/commands/spectral/upload.js)_
|
|
1563
1674
|
<!-- commandsstop -->
|
|
1564
1675
|
|
|
1565
1676
|
# Plugins
|