swaggerhub-cli 0.2.15 → 0.6.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.
Files changed (41) hide show
  1. package/README.md +498 -64
  2. package/oclif.manifest.json +1 -1
  3. package/package.json +28 -20
  4. package/src/commands/api/create.js +7 -6
  5. package/src/commands/api/delete.js +63 -0
  6. package/src/commands/api/publish.js +1 -1
  7. package/src/commands/api/unpublish.js +5 -13
  8. package/src/commands/api/update.js +21 -41
  9. package/src/commands/domain/create.js +5 -4
  10. package/src/commands/domain/delete.js +63 -0
  11. package/src/commands/domain/publish.js +1 -1
  12. package/src/commands/domain/setdefault.js +30 -0
  13. package/src/commands/domain/unpublish.js +4 -12
  14. package/src/commands/domain/update.js +109 -0
  15. package/src/commands/integration/create.js +3 -25
  16. package/src/commands/integration/delete.js +40 -0
  17. package/src/commands/integration/execute.js +40 -0
  18. package/src/commands/integration/get.js +51 -0
  19. package/src/commands/integration/list.js +62 -0
  20. package/src/commands/integration/update.js +51 -0
  21. package/src/commands/project/api/add.js +48 -0
  22. package/src/commands/project/api/remove.js +69 -0
  23. package/src/commands/project/create.js +77 -0
  24. package/src/commands/project/delete.js +44 -0
  25. package/src/commands/project/domain/add.js +48 -0
  26. package/src/commands/project/domain/remove.js +69 -0
  27. package/src/commands/project/get.js +51 -0
  28. package/src/commands/project/list.js +62 -0
  29. package/src/commands/project/member/list.js +60 -0
  30. package/src/config/index.js +4 -2
  31. package/src/format-readme.js +38 -0
  32. package/src/help.js +1 -1
  33. package/src/requests/api.js +5 -3
  34. package/src/requests/domain.js +4 -4
  35. package/src/requests/project.js +20 -0
  36. package/src/requests/spec.js +12 -0
  37. package/src/support/command/parse-input.js +44 -0
  38. package/src/support/command/update-command.js +21 -3
  39. package/src/template-strings/errors.js +1 -1
  40. package/src/template-strings/info.js +38 -3
  41. package/src/utils/oas.js +3 -3
package/README.md CHANGED
@@ -16,7 +16,7 @@ The SwaggerHub CLI enables teams to build automation and workflows around Swagge
16
16
  * [Contributing](#contributing)
17
17
  <!-- tocstop -->
18
18
  # Requirements
19
- Node.js 10 or later.
19
+ Node.js 12 or later.
20
20
  # Installation
21
21
  ```sh-session
22
22
  $ npm i -g swaggerhub-cli
@@ -25,7 +25,7 @@ $ npm i -g swaggerhub-cli
25
25
  The SwaggerHub CLI can be configured through environment variables or through the [`swaggerhub configure`](#swaggerhub-configure) command. The CLI will look for the following environment variables.
26
26
 
27
27
  * `SWAGGERHUB_API_KEY` (required) – **Important: keep this key secure.** This is the SwaggerHub API key the CLI will use for authentication. You can find your API key on the [user settings page](https://app.swaggerhub.com/settings/apiKey) in SwaggerHub.
28
- * `SWAGGERHUB_URL` (optional, default is `https://api.swaggerhub.com/`) – Customers with on-premise installations need to point this to their on-premise API, which is `http(s)://{swaggerhub-host}/v1` (do not append a backslash).
28
+ * `SWAGGERHUB_URL` (optional, default is `https://api.swaggerhub.com`) – Customers with on-premise installations need to point this to their on-premise API, which is `http(s)://{swaggerhub-host}/v1` (do not append a backslash).
29
29
 
30
30
  Alernatively, you can use the `swaggerhub configure` command to create a configuration file for the CLI to use. This command will walk you through the steps to set up the necessary configurations.
31
31
 
@@ -37,7 +37,7 @@ $ swaggerhub configure
37
37
 
38
38
  Environment variables take precedence over the configuration file created by this command.
39
39
 
40
- ## Additional configuration for SwaggerHub On-Premise
40
+ # Additional configuration for SwaggerHub On-Premise
41
41
 
42
42
  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.
43
43
 
@@ -102,6 +102,7 @@ USAGE
102
102
  # Commands
103
103
  <!-- commands -->
104
104
  * [`swaggerhub api:create OWNER/API_NAME/[VERSION]`](#swaggerhub-apicreate)
105
+ * [`swaggerhub api:delete OWNER/API_NAME/[VERSION]`](#swaggerhub-apidelete)
105
106
  * [`swaggerhub api:get OWNER/API_NAME/[VERSION]`](#swaggerhub-apiget)
106
107
  * [`swaggerhub api:publish OWNER/API_NAME/VERSION`](#swaggerhub-apipublish)
107
108
  * [`swaggerhub api:setdefault OWNER/API_NAME/VERSION`](#swaggerhub-apisetdefault)
@@ -110,16 +111,34 @@ USAGE
110
111
  * [`swaggerhub api:validate OWNER/API_NAME/[VERSION]`](#swaggerhub-apivalidate)
111
112
  * [`swaggerhub configure`](#swaggerhub-configure)
112
113
  * [`swaggerhub domain:create OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domaincreate)
114
+ * [`swaggerhub domain:delete OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domaindelete)
113
115
  * [`swaggerhub domain:get OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domainget)
114
116
  * [`swaggerhub domain:publish OWNER/DOMAIN_NAME/VERSION`](#swaggerhub-domainpublish)
117
+ * [`swaggerhub domain:setdefault OWNER/DOMAIN_NAME/VERSION`](#swaggerhub-domainsetdefault)
115
118
  * [`swaggerhub domain:unpublish OWNER/DOMAIN_NAME/VERSION`](#swaggerhub-domainunpublish)
116
- * [`swaggerhub help [COMMAND]`](#swaggerhub-help-command)
119
+ * [`swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domainupdate)
120
+ * [`swaggerhub help [COMMAND]`](#swaggerhub-help)
117
121
  * [`swaggerhub integration:create OWNER/API_NAME/[VERSION]`](#swaggerhub-integrationcreate)
122
+ * [`swaggerhub integration:delete OWNER/API_NAME/VERSION/INTEGRATION_ID`](#swaggerhub-integrationdelete)
123
+ * [`swaggerhub integration:execute OWNER/API_NAME/VERSION/INTEGRATION_ID`](#swaggerhub-integrationexecute)
124
+ * [`swaggerhub integration:get OWNER/API_NAME/VERSION/INTEGRATION_ID`](#swaggerhub-integrationget)
125
+ * [`swaggerhub integration:list OWNER/API_NAME/[VERSION]`](#swaggerhub-integrationlist)
126
+ * [`swaggerhub integration:update OWNER/API_NAME/VERSION/INTEGRATION_ID`](#swaggerhub-integrationupdate)
118
127
  * [`swaggerhub plugins`](#swaggerhub-plugins)
119
- * [`swaggerhub plugins:install PLUGIN...`](#swaggerhub-pluginsinstall-plugin)
120
- * [`swaggerhub plugins:link PLUGIN`](#swaggerhub-pluginslink-plugin)
121
- * [`swaggerhub plugins:uninstall PLUGIN...`](#swaggerhub-pluginsuninstall-plugin)
128
+ * [`swaggerhub plugins:inspect PLUGIN...`](#swaggerhub-pluginsinspect)
129
+ * [`swaggerhub plugins:install PLUGIN...`](#swaggerhub-pluginsinstall)
130
+ * [`swaggerhub plugins:link PLUGIN`](#swaggerhub-pluginslink)
131
+ * [`swaggerhub plugins:uninstall PLUGIN...`](#swaggerhub-pluginsuninstall)
122
132
  * [`swaggerhub plugins:update`](#swaggerhub-pluginsupdate)
133
+ * [`swaggerhub project:api:add OWNER/PROJECT_NAME API`](#swaggerhub-projectapiadd)
134
+ * [`swaggerhub project:api:remove OWNER/PROJECT_NAME API`](#swaggerhub-projectapiremove)
135
+ * [`swaggerhub project:create OWNER/PROJECT_NAME`](#swaggerhub-projectcreate)
136
+ * [`swaggerhub project:delete OWNER/PROJECT_NAME`](#swaggerhub-projectdelete)
137
+ * [`swaggerhub project:domain:add OWNER/PROJECT_NAME DOMAIN`](#swaggerhub-projectdomainadd)
138
+ * [`swaggerhub project:domain:remove OWNER/PROJECT_NAME DOMAIN`](#swaggerhub-projectdomainremove)
139
+ * [`swaggerhub project:get OWNER/PROJECT_NAME`](#swaggerhub-projectget)
140
+ * [`swaggerhub project:list [OWNER]`](#swaggerhub-projectlist)
141
+ * [`swaggerhub project:member:list OWNER/PROJECT_NAME`](#swaggerhub-projectmemberlist)
123
142
 
124
143
  ## `swaggerhub api:create`
125
144
 
@@ -133,11 +152,11 @@ ARGUMENTS
133
152
  OWNER/API_NAME/[VERSION] API to create in SwaggerHub
134
153
 
135
154
  OPTIONS
136
- -f, --file=file (required) file location of API to create
137
- -h, --help show CLI help
138
- --publish sets the API version as published
139
- --setdefault sets API version to be the default
140
- --visibility=public|private [default: private] visibility of API in SwaggerHub
155
+ -f, --file=file (required) file location of API to create
156
+ -h, --help show CLI help
157
+ --published=publish|unpublish [default: unpublish] sets the lifecycle setting of the API version
158
+ --setdefault sets API version to be the default
159
+ --visibility=public|private [default: private] visibility of API in SwaggerHub
141
160
 
142
161
  DESCRIPTION
143
162
  The API version from the file will be used unless the version is specified in the command argument.
@@ -146,12 +165,35 @@ DESCRIPTION
146
165
  EXAMPLES
147
166
  swaggerhub api:create organization/api/1.0.0 --file api.yaml --visibility public
148
167
  swaggerhub api:create organization/api --file api.yaml
149
- swaggerhub api:create organization/api/1.0.0 --publish --file api.json
168
+ swaggerhub api:create organization/api/1.0.0 --published=publish --file api.json
150
169
  swaggerhub api:create organization/api/1.0.0 --setdefault --file api.json
151
- swaggerhub api:create organization/api/1.0.0 --publish --setdefault --file api.json
170
+ swaggerhub api:create organization/api/1.0.0 --published=publish --setdefault --file api.json
152
171
  ```
153
172
 
154
- _See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.2.15/src/commands/api/create.js)_
173
+ _See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/api/create.js)_
174
+
175
+ ## `swaggerhub api:delete`
176
+
177
+ delete an API or API version
178
+
179
+ ```
180
+ USAGE
181
+ $ swaggerhub api:delete OWNER/API_NAME/[VERSION]
182
+
183
+ ARGUMENTS
184
+ OWNER/API_NAME/[VERSION] API to delete in SwaggerHub
185
+
186
+ OPTIONS
187
+ -f, --force delete API without prompting for confirmation
188
+ -h, --help show CLI help
189
+
190
+ EXAMPLES
191
+ swaggerhub api:delete organization/api/1.0.0
192
+ swaggerhub api:delete organization/api
193
+ swaggerhub api:delete organization/api --force
194
+ ```
195
+
196
+ _See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/api/delete.js)_
155
197
 
156
198
  ## `swaggerhub api:get`
157
199
 
@@ -178,7 +220,7 @@ EXAMPLES
178
220
  swaggerhub api:get organization/api/1.0.0 --json
179
221
  ```
180
222
 
181
- _See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.2.15/src/commands/api/get.js)_
223
+ _See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/api/get.js)_
182
224
 
183
225
  ## `swaggerhub api:publish`
184
226
 
@@ -198,7 +240,7 @@ EXAMPLE
198
240
  swaggerhub api:publish organization/api/1.0.0
199
241
  ```
200
242
 
201
- _See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.2.15/src/commands/api/publish.js)_
243
+ _See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/api/publish.js)_
202
244
 
203
245
  ## `swaggerhub api:setdefault`
204
246
 
@@ -218,7 +260,7 @@ EXAMPLE
218
260
  swaggerhub api:setdefault organization/api/2.0.0
219
261
  ```
220
262
 
221
- _See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.2.15/src/commands/api/setdefault.js)_
263
+ _See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/api/setdefault.js)_
222
264
 
223
265
  ## `swaggerhub api:unpublish`
224
266
 
@@ -238,7 +280,7 @@ EXAMPLE
238
280
  swaggerhub api:unpublish organization/api/1.0.0
239
281
  ```
240
282
 
241
- _See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.2.15/src/commands/api/unpublish.js)_
283
+ _See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/api/unpublish.js)_
242
284
 
243
285
  ## `swaggerhub api:update`
244
286
 
@@ -252,11 +294,11 @@ ARGUMENTS
252
294
  OWNER/API_NAME/[VERSION] API to update in SwaggerHub
253
295
 
254
296
  OPTIONS
255
- -f, --file=file file location of API to update
256
- -h, --help show CLI help
257
- --publish sets the API version as published
258
- --setdefault sets API version to be the default
259
- --visibility=public|private visibility of API in SwaggerHub
297
+ -f, --file=file file location of API to update
298
+ -h, --help show CLI help
299
+ --published=publish|unpublish sets the lifecycle setting of the API version
300
+ --setdefault sets API version to be the default
301
+ --visibility=public|private visibility of API in SwaggerHub
260
302
 
261
303
  DESCRIPTION
262
304
  The API version from the file will be used unless the version is specified in the command argument.
@@ -266,13 +308,13 @@ DESCRIPTION
266
308
  EXAMPLES
267
309
  swaggerhub api:update organization/api --file api.yaml
268
310
  swaggerhub api:update organization/api/1.0.0 --file api.json
269
- swaggerhub api:update organization/api/1.0.0 --publish --file api.json
311
+ swaggerhub api:update organization/api/1.0.0 --published=publish --file api.json
270
312
  swaggerhub api:update organization/api/1.0.0 --setdefault --file api.json
271
- swaggerhub api:update organization/api/1.0.0 --publish --setdefault --file api.json
313
+ swaggerhub api:update organization/api/1.0.0 --published=unpublish --setdefault --file api.json
272
314
  swaggerhub api:update organization/api/1.0.0 --visibility=private
273
315
  ```
274
316
 
275
- _See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.2.15/src/commands/api/update.js)_
317
+ _See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/api/update.js)_
276
318
 
277
319
  ## `swaggerhub api:validate`
278
320
 
@@ -297,7 +339,7 @@ EXAMPLES
297
339
  swaggerhub api:validate organization/api
298
340
  ```
299
341
 
300
- _See code: [src/commands/api/validate.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.2.15/src/commands/api/validate.js)_
342
+ _See code: [src/commands/api/validate.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/api/validate.js)_
301
343
 
302
344
  ## `swaggerhub configure`
303
345
 
@@ -319,7 +361,7 @@ DESCRIPTION
319
361
  settings.
320
362
  ```
321
363
 
322
- _See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.2.15/src/commands/configure.js)_
364
+ _See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/configure.js)_
323
365
 
324
366
  ## `swaggerhub domain:create`
325
367
 
@@ -333,11 +375,11 @@ ARGUMENTS
333
375
  OWNER/DOMAIN_NAME/[VERSION] Domain to create in SwaggerHub
334
376
 
335
377
  OPTIONS
336
- -f, --file=file (required) file location of domain to create
337
- -h, --help show CLI help
338
- --publish sets the domain version as published
339
- --setdefault sets domain version to be the default
340
- --visibility=public|private [default: private] visibility of domain in SwaggerHub
378
+ -f, --file=file (required) file location of domain to create
379
+ -h, --help show CLI help
380
+ --published=publish|unpublish [default: unpublish] sets the lifecycle setting of the domain version
381
+ --setdefault sets domain version to be the default
382
+ --visibility=public|private [default: private] visibility of domain in SwaggerHub
341
383
 
342
384
  DESCRIPTION
343
385
  The domain version from the file will be used unless the version is specified in the command argument.
@@ -351,7 +393,30 @@ EXAMPLES
351
393
  swaggerhub domain:create organization/domain/1.0.0 --publish --setdefault --file domain.json
352
394
  ```
353
395
 
354
- _See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.2.15/src/commands/domain/create.js)_
396
+ _See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/domain/create.js)_
397
+
398
+ ## `swaggerhub domain:delete`
399
+
400
+ delete a domain or domain version
401
+
402
+ ```
403
+ USAGE
404
+ $ swaggerhub domain:delete OWNER/DOMAIN_NAME/[VERSION]
405
+
406
+ ARGUMENTS
407
+ OWNER/DOMAIN_NAME/[VERSION] Domain to delete in SwaggerHub
408
+
409
+ OPTIONS
410
+ -f, --force delete domain without prompting for confirmation
411
+ -h, --help show CLI help
412
+
413
+ EXAMPLES
414
+ swaggerhub domain:delete organization/domain/1.0.0
415
+ swaggerhub domain:delete organization/domain
416
+ swaggerhub domain:delete organization/domain --force
417
+ ```
418
+
419
+ _See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/domain/delete.js)_
355
420
 
356
421
  ## `swaggerhub domain:get`
357
422
 
@@ -377,7 +442,7 @@ EXAMPLES
377
442
  swaggerhub domain:get organization/domain/1.0.0 --json
378
443
  ```
379
444
 
380
- _See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.2.15/src/commands/domain/get.js)_
445
+ _See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/domain/get.js)_
381
446
 
382
447
  ## `swaggerhub domain:publish`
383
448
 
@@ -397,7 +462,27 @@ EXAMPLE
397
462
  swaggerhub domain:publish organization/domain/1.0.0
398
463
  ```
399
464
 
400
- _See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.2.15/src/commands/domain/publish.js)_
465
+ _See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/domain/publish.js)_
466
+
467
+ ## `swaggerhub domain:setdefault`
468
+
469
+ set the default version of a domain
470
+
471
+ ```
472
+ USAGE
473
+ $ swaggerhub domain:setdefault OWNER/DOMAIN_NAME/VERSION
474
+
475
+ ARGUMENTS
476
+ OWNER/DOMAIN_NAME/VERSION domain identifier
477
+
478
+ OPTIONS
479
+ -h, --help show CLI help
480
+
481
+ EXAMPLE
482
+ swaggerhub domain:setdefault organization/domain/2.0.0
483
+ ```
484
+
485
+ _See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/domain/setdefault.js)_
401
486
 
402
487
  ## `swaggerhub domain:unpublish`
403
488
 
@@ -417,9 +502,43 @@ EXAMPLE
417
502
  swaggerhub domain:unpublish organization/domain/1.0.0
418
503
  ```
419
504
 
420
- _See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.2.15/src/commands/domain/unpublish.js)_
505
+ _See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/domain/unpublish.js)_
506
+
507
+ ## `swaggerhub domain:update`
421
508
 
422
- ## `swaggerhub help [COMMAND]`
509
+ update a domain
510
+
511
+ ```
512
+ USAGE
513
+ $ swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION]
514
+
515
+ ARGUMENTS
516
+ OWNER/DOMAIN_NAME/[VERSION] domain to update in SwaggerHub
517
+
518
+ OPTIONS
519
+ -f, --file=file file location of domain to update
520
+ -h, --help show CLI help
521
+ --published=publish|unpublish sets the lifecycle setting of the domain version
522
+ --setdefault sets domain version to be the default
523
+ --visibility=public|private visibility of domain in SwaggerHub
524
+
525
+ DESCRIPTION
526
+ The domain version from the file will be used unless the version is specified in the command argument.
527
+ When no file is specified then the default domain version will be updated.
528
+ The domain visibility can be changed by using visibility flag.
529
+
530
+ EXAMPLES
531
+ swaggerhub domain:update organization/domain --file domain.yaml
532
+ swaggerhub domain:update organization/domain/1.0.0 --file domain.json
533
+ swaggerhub domain:update organization/domain/1.0.0 --published=publish --file domain.json
534
+ swaggerhub domain:update organization/domain/1.0.0 --setdefault --file domain.json
535
+ swaggerhub domain:update organization/domain/1.0.0 --published=unpublish --setdefault --file domain.json
536
+ swaggerhub domain:update organization/domain/1.0.0 --visibility=private
537
+ ```
538
+
539
+ _See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/domain/update.js)_
540
+
541
+ ## `swaggerhub help`
423
542
 
424
543
  display help for swaggerhub
425
544
 
@@ -434,11 +553,11 @@ OPTIONS
434
553
  --all see all commands in CLI
435
554
  ```
436
555
 
437
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_
556
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.3.1/src/commands/help.ts)_
438
557
 
439
558
  ## `swaggerhub integration:create`
440
559
 
441
- creates a new API integation from a JSON configuration file.
560
+ creates a new API integration from a JSON configuration file.
442
561
 
443
562
  ```
444
563
  USAGE
@@ -460,39 +579,161 @@ EXAMPLE
460
579
  swaggerhub integration:create organization/api/1.0.0 --file config.json
461
580
  ```
462
581
 
463
- _See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.2.15/src/commands/integration/create.js)_
582
+ _See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/integration/create.js)_
583
+
584
+ ## `swaggerhub integration:delete`
585
+
586
+ deletes the integration from the given API.
587
+
588
+ ```
589
+ USAGE
590
+ $ swaggerhub integration:delete OWNER/API_NAME/VERSION/INTEGRATION_ID
591
+
592
+ ARGUMENTS
593
+ OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to delete
594
+
595
+ OPTIONS
596
+ -h, --help show CLI help
597
+
598
+ EXAMPLE
599
+ swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
600
+ ```
601
+
602
+ _See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/integration/delete.js)_
603
+
604
+ ## `swaggerhub integration:execute`
605
+
606
+ executes an integration for the given API.
607
+
608
+ ```
609
+ USAGE
610
+ $ swaggerhub integration:execute OWNER/API_NAME/VERSION/INTEGRATION_ID
611
+
612
+ ARGUMENTS
613
+ OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to execute for given API
614
+
615
+ OPTIONS
616
+ -h, --help show CLI help
617
+
618
+ EXAMPLE
619
+ swaggerhub integration:execute organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
620
+ ```
621
+
622
+ _See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/integration/execute.js)_
623
+
624
+ ## `swaggerhub integration:get`
625
+
626
+ retieves an integration for the given API.
627
+
628
+ ```
629
+ USAGE
630
+ $ swaggerhub integration:get OWNER/API_NAME/VERSION/INTEGRATION_ID
631
+
632
+ ARGUMENTS
633
+ OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to fetch for given API
634
+
635
+ OPTIONS
636
+ -h, --help show CLI help
637
+
638
+ EXAMPLE
639
+ swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
640
+ ```
641
+
642
+ _See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/integration/get.js)_
643
+
644
+ ## `swaggerhub integration:list`
645
+
646
+ list integrations on an API.
647
+
648
+ ```
649
+ USAGE
650
+ $ swaggerhub integration:list OWNER/API_NAME/[VERSION]
651
+
652
+ ARGUMENTS
653
+ OWNER/API_NAME/[VERSION] API to list integrations on
654
+
655
+ OPTIONS
656
+ -h, --help show CLI help
657
+
658
+ EXAMPLE
659
+ swaggerhub integration:list organization/api/1.0.0
660
+ ```
661
+
662
+ _See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/integration/list.js)_
663
+
664
+ ## `swaggerhub integration:update`
665
+
666
+ update the configuration of an API integration.
667
+
668
+ ```
669
+ USAGE
670
+ $ swaggerhub integration:update OWNER/API_NAME/VERSION/INTEGRATION_ID
671
+
672
+ ARGUMENTS
673
+ OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to update on the given API
674
+
675
+ OPTIONS
676
+ -f, --file=file (required) location of integration configuration file
677
+ -h, --help show CLI help
678
+
679
+ EXAMPLE
680
+ swaggerhub integration:update organization/api/1.0.0/503c2db6-448a-4678-abcd-0123456789abc --file config.json
681
+ ```
682
+
683
+ _See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/integration/update.js)_
464
684
 
465
685
  ## `swaggerhub plugins`
466
686
 
467
- list installed plugins
687
+ List installed plugins.
468
688
 
469
689
  ```
470
690
  USAGE
471
691
  $ swaggerhub plugins
472
692
 
473
693
  OPTIONS
474
- --core show core plugins
694
+ --core Show core plugins.
475
695
 
476
696
  EXAMPLE
477
697
  $ swaggerhub plugins
478
698
  ```
479
699
 
480
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.4/src/commands/plugins/index.ts)_
700
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/index.ts)_
701
+
702
+ ## `swaggerhub plugins:inspect`
703
+
704
+ Displays installation properties of a plugin.
705
+
706
+ ```
707
+ USAGE
708
+ $ swaggerhub plugins:inspect PLUGIN...
709
+
710
+ ARGUMENTS
711
+ PLUGIN [default: .] Plugin to inspect.
712
+
713
+ OPTIONS
714
+ -h, --help Show CLI help.
715
+ -v, --verbose
716
+
717
+ EXAMPLE
718
+ $ swaggerhub plugins:inspect myplugin
719
+ ```
720
+
721
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/inspect.ts)_
481
722
 
482
- ## `swaggerhub plugins:install PLUGIN...`
723
+ ## `swaggerhub plugins:install`
483
724
 
484
- installs a plugin into the CLI
725
+ Installs a plugin into the CLI.
485
726
 
486
727
  ```
487
728
  USAGE
488
729
  $ swaggerhub plugins:install PLUGIN...
489
730
 
490
731
  ARGUMENTS
491
- PLUGIN plugin to install
732
+ PLUGIN Plugin to install.
492
733
 
493
734
  OPTIONS
494
- -f, --force yarn install with force flag
495
- -h, --help show CLI help
735
+ -f, --force Run yarn install with force flag.
736
+ -h, --help Show CLI help.
496
737
  -v, --verbose
497
738
 
498
739
  DESCRIPTION
@@ -501,7 +742,7 @@ DESCRIPTION
501
742
  Installation of a user-installed plugin will override a core plugin.
502
743
 
503
744
  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
504
- will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
745
+ will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
505
746
  the CLI without the need to patch and update the whole CLI.
506
747
 
507
748
  ALIASES
@@ -513,11 +754,11 @@ EXAMPLES
513
754
  $ swaggerhub plugins:install someuser/someplugin
514
755
  ```
515
756
 
516
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.4/src/commands/plugins/install.ts)_
757
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/install.ts)_
517
758
 
518
- ## `swaggerhub plugins:link PLUGIN`
759
+ ## `swaggerhub plugins:link`
519
760
 
520
- links a plugin into the CLI for development
761
+ Links a plugin into the CLI for development.
521
762
 
522
763
  ```
523
764
  USAGE
@@ -527,24 +768,24 @@ ARGUMENTS
527
768
  PATH [default: .] path to plugin
528
769
 
529
770
  OPTIONS
530
- -h, --help show CLI help
771
+ -h, --help Show CLI help.
531
772
  -v, --verbose
532
773
 
533
774
  DESCRIPTION
534
775
  Installation of a linked plugin will override a user-installed or core plugin.
535
776
 
536
777
  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
537
- command will override the user-installed or core plugin implementation. This is useful for development work.
778
+ command will override the user-installed or core plugin implementation. This is useful for development work.
538
779
 
539
780
  EXAMPLE
540
781
  $ swaggerhub plugins:link myplugin
541
782
  ```
542
783
 
543
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.4/src/commands/plugins/link.ts)_
784
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/link.ts)_
544
785
 
545
- ## `swaggerhub plugins:uninstall PLUGIN...`
786
+ ## `swaggerhub plugins:uninstall`
546
787
 
547
- removes a plugin from the CLI
788
+ Removes a plugin from the CLI.
548
789
 
549
790
  ```
550
791
  USAGE
@@ -554,7 +795,7 @@ ARGUMENTS
554
795
  PLUGIN plugin to uninstall
555
796
 
556
797
  OPTIONS
557
- -h, --help show CLI help
798
+ -h, --help Show CLI help.
558
799
  -v, --verbose
559
800
 
560
801
  ALIASES
@@ -562,22 +803,215 @@ ALIASES
562
803
  $ swaggerhub plugins:remove
563
804
  ```
564
805
 
565
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.4/src/commands/plugins/uninstall.ts)_
806
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/uninstall.ts)_
566
807
 
567
808
  ## `swaggerhub plugins:update`
568
809
 
569
- update installed plugins
810
+ Update installed plugins.
570
811
 
571
812
  ```
572
813
  USAGE
573
814
  $ swaggerhub plugins:update
574
815
 
575
816
  OPTIONS
576
- -h, --help show CLI help
817
+ -h, --help Show CLI help.
577
818
  -v, --verbose
578
819
  ```
579
820
 
580
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.4/src/commands/plugins/update.ts)_
821
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/update.ts)_
822
+
823
+ ## `swaggerhub project:api:add`
824
+
825
+ Adds an API to an existing project.
826
+
827
+ ```
828
+ USAGE
829
+ $ swaggerhub project:api:add OWNER/PROJECT_NAME API
830
+
831
+ ARGUMENTS
832
+ OWNER/PROJECT_NAME The project to add the API to
833
+ API The name of the API to add
834
+
835
+ OPTIONS
836
+ -h, --help show CLI help
837
+
838
+ EXAMPLE
839
+ swaggerhub project:api:add organization/project_name my_api
840
+ ```
841
+
842
+ _See code: [src/commands/project/api/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/project/api/add.js)_
843
+
844
+ ## `swaggerhub project:api:remove`
845
+
846
+ Removes an API from a project in SwaggerHub.
847
+
848
+ ```
849
+ USAGE
850
+ $ swaggerhub project:api:remove OWNER/PROJECT_NAME API
851
+
852
+ ARGUMENTS
853
+ OWNER/PROJECT_NAME The project remove the API from
854
+ API The API to remove
855
+
856
+ OPTIONS
857
+ -h, --help show CLI help
858
+
859
+ EXAMPLE
860
+ swaggerhub project:api:remove organization/project_name my_api
861
+ ```
862
+
863
+ _See code: [src/commands/project/api/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/project/api/remove.js)_
864
+
865
+ ## `swaggerhub project:create`
866
+
867
+ Creates a new project in SwaggerHub.
868
+
869
+ ```
870
+ USAGE
871
+ $ swaggerhub project:create OWNER/PROJECT_NAME
872
+
873
+ ARGUMENTS
874
+ OWNER/PROJECT_NAME The new project to create
875
+
876
+ OPTIONS
877
+ -a, --apis=apis Comma separated list of api names to include in project
878
+ -d, --domains=domains Comma separated list of domain names to include in project
879
+ -h, --help show CLI help
880
+ --description=description Description of project
881
+
882
+ EXAMPLES
883
+ swaggerhub project:create organization/new_project_name --description "project description"
884
+ swaggerhub project:create organization/new_project_name -a "testapi1,testapi2"
885
+ swaggerhub project:create organization/new_project_name --apis "testapi1,testapi2"
886
+ swaggerhub project:create organization/new_project_name -d "testdomain3,testdomain4"
887
+ swaggerhub project:create organization/new_project_name --domains "testdomain3,testdomain4"
888
+ swaggerhub project:create organization/new_project_name -a "testapi1" -d "testdomain3" --description "description"
889
+ ```
890
+
891
+ _See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/project/create.js)_
892
+
893
+ ## `swaggerhub project:delete`
894
+
895
+ Deletes a project from SwaggerHub.
896
+
897
+ ```
898
+ USAGE
899
+ $ swaggerhub project:delete OWNER/PROJECT_NAME
900
+
901
+ ARGUMENTS
902
+ OWNER/PROJECT_NAME Project to delete
903
+
904
+ OPTIONS
905
+ -h, --help show CLI help
906
+
907
+ EXAMPLE
908
+ swaggerhub project:delete organization/project_name
909
+ ```
910
+
911
+ _See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/project/delete.js)_
912
+
913
+ ## `swaggerhub project:domain:add`
914
+
915
+ Adds a domain to an existing project.
916
+
917
+ ```
918
+ USAGE
919
+ $ swaggerhub project:domain:add OWNER/PROJECT_NAME DOMAIN
920
+
921
+ ARGUMENTS
922
+ OWNER/PROJECT_NAME The project to add the domain to
923
+ DOMAIN The name of the domain to add
924
+
925
+ OPTIONS
926
+ -h, --help show CLI help
927
+
928
+ EXAMPLE
929
+ swaggerhub project:domain:add organization/project_name my_domain
930
+ ```
931
+
932
+ _See code: [src/commands/project/domain/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/project/domain/add.js)_
933
+
934
+ ## `swaggerhub project:domain:remove`
935
+
936
+ Removes a domain from a project in SwaggerHub.
937
+
938
+ ```
939
+ USAGE
940
+ $ swaggerhub project:domain:remove OWNER/PROJECT_NAME DOMAIN
941
+
942
+ ARGUMENTS
943
+ OWNER/PROJECT_NAME The project remove the domain from
944
+ DOMAIN The domain to remove
945
+
946
+ OPTIONS
947
+ -h, --help show CLI help
948
+
949
+ EXAMPLE
950
+ swaggerhub project:domain:remove organization/project_name my_domain
951
+ ```
952
+
953
+ _See code: [src/commands/project/domain/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/project/domain/remove.js)_
954
+
955
+ ## `swaggerhub project:get`
956
+
957
+ Retrieves the details for a project.
958
+
959
+ ```
960
+ USAGE
961
+ $ swaggerhub project:get OWNER/PROJECT_NAME
962
+
963
+ ARGUMENTS
964
+ OWNER/PROJECT_NAME Project to retrieve the details for
965
+
966
+ OPTIONS
967
+ -h, --help show CLI help
968
+
969
+ EXAMPLE
970
+ swaggerhub project:get organization/project_name
971
+ ```
972
+
973
+ _See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/project/get.js)_
974
+
975
+ ## `swaggerhub project:list`
976
+
977
+ list projects
978
+
979
+ ```
980
+ USAGE
981
+ $ swaggerhub project:list [OWNER]
982
+
983
+ ARGUMENTS
984
+ OWNER Organization to list projects for
985
+
986
+ OPTIONS
987
+ -h, --help show CLI help
988
+
989
+ EXAMPLES
990
+ swaggerhub project:list
991
+ swaggerhub project:list organization
992
+ ```
993
+
994
+ _See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/project/list.js)_
995
+
996
+ ## `swaggerhub project:member:list`
997
+
998
+ list members of a project
999
+
1000
+ ```
1001
+ USAGE
1002
+ $ swaggerhub project:member:list OWNER/PROJECT_NAME
1003
+
1004
+ ARGUMENTS
1005
+ OWNER/PROJECT_NAME Project to list members of
1006
+
1007
+ OPTIONS
1008
+ -h, --help show CLI help
1009
+
1010
+ EXAMPLE
1011
+ swaggerhub project:member:list organisation/project_name
1012
+ ```
1013
+
1014
+ _See code: [src/commands/project/member/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.6.0/src/commands/project/member/list.js)_
581
1015
  <!-- commandsstop -->
582
1016
 
583
1017
  # Plugins