swaggerhub-cli 0.13.0 → 0.15.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 (72) hide show
  1. package/README.md +209 -122
  2. package/bin/run +5 -4
  3. package/oclif.manifest.json +283 -122
  4. package/package.json +14 -12
  5. package/src/check-node-version.js +3 -2
  6. package/src/commands/api/clone.js +66 -0
  7. package/src/commands/api/create.js +10 -10
  8. package/src/commands/api/delete.js +7 -7
  9. package/src/commands/api/get.js +9 -9
  10. package/src/commands/api/publish.js +7 -7
  11. package/src/commands/api/rename.js +8 -10
  12. package/src/commands/api/setdefault.js +6 -6
  13. package/src/commands/api/unpublish.js +5 -5
  14. package/src/commands/api/update.js +11 -11
  15. package/src/commands/api/validate/download-rules.js +11 -11
  16. package/src/commands/api/validate/index.js +10 -10
  17. package/src/commands/api/validate/local.js +11 -11
  18. package/src/commands/configure.js +8 -8
  19. package/src/commands/domain/clone.js +66 -0
  20. package/src/commands/domain/create.js +14 -14
  21. package/src/commands/domain/delete.js +7 -7
  22. package/src/commands/domain/get.js +8 -8
  23. package/src/commands/domain/publish.js +6 -6
  24. package/src/commands/domain/rename.js +78 -0
  25. package/src/commands/domain/setdefault.js +6 -6
  26. package/src/commands/domain/unpublish.js +6 -6
  27. package/src/commands/domain/update.js +11 -11
  28. package/src/commands/integration/create.js +7 -7
  29. package/src/commands/integration/delete.js +6 -6
  30. package/src/commands/integration/execute.js +6 -6
  31. package/src/commands/integration/get.js +9 -9
  32. package/src/commands/integration/list.js +7 -7
  33. package/src/commands/integration/update.js +6 -6
  34. package/src/commands/project/api/add.js +7 -9
  35. package/src/commands/project/api/remove.js +10 -13
  36. package/src/commands/project/create.js +9 -13
  37. package/src/commands/project/delete.js +7 -7
  38. package/src/commands/project/domain/add.js +7 -9
  39. package/src/commands/project/domain/remove.js +10 -13
  40. package/src/commands/project/get.js +8 -8
  41. package/src/commands/project/list.js +6 -6
  42. package/src/commands/project/member/list.js +8 -8
  43. package/src/commands/spectral/download.js +9 -9
  44. package/src/commands/spectral/upload.js +11 -11
  45. package/src/config/index.js +18 -4
  46. package/src/format-readme.js +3 -2
  47. package/src/help.js +2 -2
  48. package/src/hooks/setup-config.js +9 -5
  49. package/src/index.js +2 -2
  50. package/src/requests/api.js +3 -3
  51. package/src/requests/domain.js +3 -3
  52. package/src/requests/project.js +2 -2
  53. package/src/requests/spec.js +5 -5
  54. package/src/requests/spectral.js +3 -3
  55. package/src/requests/standardization.js +4 -4
  56. package/src/support/command/base-command.js +11 -12
  57. package/src/support/command/base-validate-command.js +3 -3
  58. package/src/support/command/handle-response.js +7 -5
  59. package/src/support/command/parse-input.js +8 -6
  60. package/src/support/command/update-command.js +5 -5
  61. package/src/support/http/default-headers.js +1 -1
  62. package/src/support/http/header-templates.js +2 -2
  63. package/src/support/http/index.js +7 -7
  64. package/src/support/http/proxy-agent.js +4 -4
  65. package/src/support/inquirer/index.js +4 -4
  66. package/src/support/inquirer/prompt-templates.js +3 -3
  67. package/src/support/isOnPrem.js +3 -3
  68. package/src/template-strings/errors.js +6 -6
  69. package/src/template-strings/index.js +3 -3
  70. package/src/template-strings/info.js +10 -4
  71. package/src/utils/definitions.js +8 -6
  72. package/src/utils/general.js +3 -3
package/README.md CHANGED
@@ -1,39 +1,40 @@
1
- SwaggerHub CLI
1
+ Swagger CLI
2
2
  ==============
3
3
 
4
4
  [![NPM](https://img.shields.io/npm/v/swaggerhub-cli.svg)](https://www.npmjs.com/package/swaggerhub-cli)
5
5
 
6
- The SwaggerHub CLI enables teams to build automation and workflows around SwaggerHub. Teams can use it in places like their CI/CD pipeline to create new APIs, create and update API versions, and mark API versions as published and default among other features. Every team has their own workflow, and the SwaggerHub CLI can help teams build the workflow that fits their needs.
6
+ The Swagger CLI enables teams to build automation and workflows around Swagger. Teams can use it in places like their CI/CD pipeline to create new APIs, create and update API versions, and mark API versions as published and default among other features. Every team has their own workflow, and the Swagger CLI can help teams build the workflow that fits their needs.
7
7
 
8
8
  <!-- toc -->
9
9
  * [Requirements](#requirements)
10
10
  * [Installation](#installation)
11
11
  * [Setup](#setup)
12
12
  * [Using a proxy](#using-a-proxy)
13
- * [Additional configuration for SwaggerHub On-Premise](#additional-configuration-for-swaggerhub-on-premise)
13
+ * [Additional configuration for Swagger Studio On-Premise](#additional-configuration-for-swagger-studio-on-premise)
14
14
  * [Usage](#usage)
15
15
  * [Commands](#commands)
16
16
  * [Plugins](#plugins)
17
17
  * [Contributing](#contributing)
18
18
  <!-- tocstop -->
19
19
  # Requirements
20
- Node.js 22.9 or later.
20
+ * Node.js 22.12 or later.
21
+ * Swagger SaaS, or Swagger Studio On-Premise 2.x. On-Premise 1.x is not supported.
21
22
 
22
23
  # Installation
23
24
  ```sh-session
24
25
  $ npm i -g swaggerhub-cli
25
26
  ```
26
27
  # Setup
27
- 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.
28
+ The Swagger CLI can be configured through environment variables or through the [`swaggerhub configure`](#swaggerhub-configure) command. The CLI will look for the following environment variables.
28
29
 
29
- * `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.
30
- * `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).
30
+ * `SWAGGERHUB_API_KEY` (required) – **Important: keep this key secure.** This is the Swagger 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 Swagger.
31
+ * `SWAGGERHUB_URL` (optional, default is `https://api.swaggerhub.com`) – Customers with on-premise installations (version 2.x) need to point this to their on-premise API, which is `http(s)://{swaggerhub-host}/v1` (do not append a trailing slash).
31
32
 
32
- 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.
33
+ Alternatively, 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.
33
34
 
34
35
  ```sh-session
35
36
  $ swaggerhub configure
36
- ? SwaggerHub URL: https://api.swaggerhub.com
37
+ ? Swagger URL: https://api.swaggerhub.com
37
38
  ? API Key: <your-api-key>
38
39
  ```
39
40
 
@@ -53,9 +54,9 @@ Proxy credentials can be included in the URL: `http://user:password@proxy.exampl
53
54
 
54
55
  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
56
 
56
- # Additional configuration for SwaggerHub On-Premise
57
+ # Additional configuration for Swagger Studio On-Premise
57
58
 
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.
59
+ If your Swagger Studio On-Premise instance uses a **self-signed or privately signed SSL certificate**, there are additional steps required to make the Swagger CLI trust this certificate.
59
60
 
60
61
  By default, Node.js rejects self-signed or privately signed SSL certificates because their root CA is not known. You will see an error like this in the CLI output:
61
62
 
@@ -108,8 +109,8 @@ set NODE_EXTRA_CA_CERTS=%USERPROFILE%\extra-ca-certs.pem
108
109
  ```sh-session
109
110
  $ swaggerhub COMMAND
110
111
  running command...
111
- $ swaggerhub (-v|--version|version)
112
- swaggerhub/0.1.2 darwin-x64 node-v12.13.0
112
+ $ swaggerhub --version
113
+ swaggerhub-cli/0.14.0 linux-x64 node-v22.9.0
113
114
  $ swaggerhub --help [COMMAND]
114
115
  USAGE
115
116
  $ swaggerhub COMMAND
@@ -117,6 +118,7 @@ USAGE
117
118
  ```
118
119
  # Commands
119
120
  <!-- commands -->
121
+ * [`swaggerhub api:clone OWNER/API_NAME/VERSION NEW_VERSION`](#swaggerhub-apiclone)
120
122
  * [`swaggerhub api:create OWNER/API_NAME/[VERSION]`](#swaggerhub-apicreate)
121
123
  * [`swaggerhub api:delete OWNER/API_NAME/[VERSION]`](#swaggerhub-apidelete)
122
124
  * [`swaggerhub api:get OWNER/API_NAME/[VERSION]`](#swaggerhub-apiget)
@@ -129,10 +131,12 @@ USAGE
129
131
  * [`swaggerhub api:validate:download-rules OWNER`](#swaggerhub-apivalidatedownload)
130
132
  * [`swaggerhub api:validate:local`](#swaggerhub-apivalidatelocal)
131
133
  * [`swaggerhub configure`](#swaggerhub-configure)
134
+ * [`swaggerhub domain:clone OWNER/DOMAIN_NAME/VERSION NEW_VERSION`](#swaggerhub-domainclone)
132
135
  * [`swaggerhub domain:create OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domaincreate)
133
136
  * [`swaggerhub domain:delete OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domaindelete)
134
137
  * [`swaggerhub domain:get OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domainget)
135
138
  * [`swaggerhub domain:publish OWNER/DOMAIN_NAME/VERSION`](#swaggerhub-domainpublish)
139
+ * [`swaggerhub domain:rename OWNER/DOMAIN_NAME DOMAIN_NEW_NAME`](#swaggerhub-domainrename)
136
140
  * [`swaggerhub domain:setdefault OWNER/DOMAIN_NAME/VERSION`](#swaggerhub-domainsetdefault)
137
141
  * [`swaggerhub domain:unpublish OWNER/DOMAIN_NAME/VERSION`](#swaggerhub-domainunpublish)
138
142
  * [`swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domainupdate)
@@ -165,6 +169,34 @@ USAGE
165
169
  * [`swaggerhub spectral:download OWNER/RULESET_NAME DIRECTORY`](#swaggerhub-spectraldownload)
166
170
  * [`swaggerhub spectral:upload OWNER/RULESET_NAME DIRECTORY`](#swaggerhub-spectralupload)
167
171
 
172
+ ## `swaggerhub api:clone`
173
+
174
+ clone an API version as a new version
175
+
176
+ ```
177
+ USAGE
178
+ $ swaggerhub api:clone OWNER/API_NAME/VERSION NEW_VERSION [--visibility public|private] [-h]
179
+
180
+ ARGUMENTS
181
+ OWNER/API_NAME/VERSION API version to clone
182
+ NEW_VERSION Version identifier of the new API version
183
+
184
+ FLAGS
185
+ -h, --help Show CLI help.
186
+ --visibility=<option> visibility of the new version (defaults to the server setting)
187
+ <options: public|private>
188
+
189
+ DESCRIPTION
190
+ clone an API version as a new version
191
+
192
+ EXAMPLES
193
+ $ swaggerhub api:clone organization/api/1.0.0 1.0.1
194
+
195
+ $ swaggerhub api:clone organization/api/1.0.0 1.0.1 --visibility public
196
+ ```
197
+
198
+ _See code: [src/commands/api/clone.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/api/clone.js)_
199
+
168
200
  ## `swaggerhub api:create`
169
201
 
170
202
  creates a new API / API version from a YAML/JSON file
@@ -175,7 +207,7 @@ USAGE
175
207
  -f <value>) [--setdefault ] [-h]
176
208
 
177
209
  ARGUMENTS
178
- OWNER/API_NAME/[VERSION] API to create on SwaggerHub
210
+ OWNER/API_NAME/[VERSION] API to create on Swagger
179
211
 
180
212
  FLAGS
181
213
  -f, --file=<value> (required) file location of API to create
@@ -183,7 +215,7 @@ FLAGS
183
215
  --published=<option> [default: unpublish] sets the lifecycle setting of the API version
184
216
  <options: publish|unpublish>
185
217
  --setdefault sets API version to be the default
186
- --visibility=<option> [default: private] visibility of API in SwaggerHub
218
+ --visibility=<option> [default: private] visibility of API in Swagger
187
219
  <options: public|private>
188
220
 
189
221
  DESCRIPTION
@@ -204,7 +236,7 @@ EXAMPLES
204
236
  $ swaggerhub api:create organization/api/1.0.0 --published=publish --setdefault --file api.json
205
237
  ```
206
238
 
207
- _See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/create.js)_
239
+ _See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/api/create.js)_
208
240
 
209
241
  ## `swaggerhub api:delete`
210
242
 
@@ -215,7 +247,7 @@ USAGE
215
247
  $ swaggerhub api:delete OWNER/API_NAME/[VERSION] [-f] [-h]
216
248
 
217
249
  ARGUMENTS
218
- OWNER/API_NAME/[VERSION] API to delete on SwaggerHub
250
+ OWNER/API_NAME/[VERSION] API to delete on Swagger
219
251
 
220
252
  FLAGS
221
253
  -f, --force delete API without prompting for confirmation
@@ -233,7 +265,7 @@ EXAMPLES
233
265
  $ swaggerhub api:delete organization/api --force
234
266
  ```
235
267
 
236
- _See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/delete.js)_
268
+ _See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/api/delete.js)_
237
269
 
238
270
  ## `swaggerhub api:get`
239
271
 
@@ -244,12 +276,12 @@ USAGE
244
276
  $ swaggerhub api:get OWNER/API_NAME/[VERSION] [-j] [-r] [-h]
245
277
 
246
278
  ARGUMENTS
247
- OWNER/API_NAME/[VERSION] API to fetch from Swaggerhub
279
+ OWNER/API_NAME/[VERSION] API to fetch from Swagger
248
280
 
249
281
  FLAGS
250
282
  -h, --help Show CLI help.
251
283
  -j, --json returns the API in JSON format.
252
- -r, --resolved gets the resolved API definition (supported in v1.25+).
284
+ -r, --resolved gets the resolved API definition
253
285
 
254
286
  DESCRIPTION
255
287
  fetches an API definition
@@ -263,7 +295,7 @@ EXAMPLES
263
295
  $ swaggerhub api:get organization/api/1.0.0 --json
264
296
  ```
265
297
 
266
- _See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/get.js)_
298
+ _See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/api/get.js)_
267
299
 
268
300
  ## `swaggerhub api:publish`
269
301
 
@@ -274,7 +306,7 @@ USAGE
274
306
  $ swaggerhub api:publish OWNER/API_NAME/VERSION [-f] [-h]
275
307
 
276
308
  ARGUMENTS
277
- OWNER/API_NAME/VERSION API to publish on Swaggerhub
309
+ OWNER/API_NAME/VERSION API to publish on Swagger
278
310
 
279
311
  FLAGS
280
312
  -f, --force publish API without prompting for confirmation
@@ -289,7 +321,7 @@ EXAMPLES
289
321
  $ swaggerhub api:publish organization/api/1.0.0 --force
290
322
  ```
291
323
 
292
- _See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/publish.js)_
324
+ _See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/api/publish.js)_
293
325
 
294
326
  ## `swaggerhub api:rename`
295
327
 
@@ -313,7 +345,7 @@ EXAMPLES
313
345
  $ swaggerhub api:rename organization/apiOldName apiNewName
314
346
  ```
315
347
 
316
- _See code: [src/commands/api/rename.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/rename.js)_
348
+ _See code: [src/commands/api/rename.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/api/rename.js)_
317
349
 
318
350
  ## `swaggerhub api:setdefault`
319
351
 
@@ -324,7 +356,7 @@ USAGE
324
356
  $ swaggerhub api:setdefault OWNER/API_NAME/VERSION [-h]
325
357
 
326
358
  ARGUMENTS
327
- OWNER/API_NAME/VERSION API to set as default on Swaggerhub
359
+ OWNER/API_NAME/VERSION API to set as default on Swagger
328
360
 
329
361
  FLAGS
330
362
  -h, --help Show CLI help.
@@ -336,7 +368,7 @@ EXAMPLES
336
368
  $ swaggerhub api:setdefault organization/api/2.0.0
337
369
  ```
338
370
 
339
- _See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/setdefault.js)_
371
+ _See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/api/setdefault.js)_
340
372
 
341
373
  ## `swaggerhub api:unpublish`
342
374
 
@@ -359,7 +391,7 @@ EXAMPLES
359
391
  $ swaggerhub api:unpublish organization/api/1.0.0
360
392
  ```
361
393
 
362
- _See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/unpublish.js)_
394
+ _See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/api/unpublish.js)_
363
395
 
364
396
  ## `swaggerhub api:update`
365
397
 
@@ -371,7 +403,7 @@ USAGE
371
403
  publish|unpublish] [--setdefault] [-h]
372
404
 
373
405
  ARGUMENTS
374
- OWNER/API_NAME/[VERSION] API to update on SwaggerHub
406
+ OWNER/API_NAME/[VERSION] API to update on Swagger
375
407
 
376
408
  FLAGS
377
409
  -f, --file=<value> file location of API to update
@@ -379,14 +411,14 @@ FLAGS
379
411
  --published=<option> sets the lifecycle setting of the API version
380
412
  <options: publish|unpublish>
381
413
  --setdefault sets API version to be the default
382
- --visibility=<option> visibility of API in SwaggerHub
414
+ --visibility=<option> visibility of API in Swagger
383
415
  <options: public|private>
384
416
 
385
417
  DESCRIPTION
386
418
  update an API
387
419
  The API version from the file will be used unless the version is specified in the command argument.
388
420
  When no file is specified then the default API version will be updated.
389
- The API visibility can be changed by using visibility flag.
421
+ The API visibility can be changed by using the --visibility flag.
390
422
 
391
423
 
392
424
  EXAMPLES
@@ -403,7 +435,7 @@ EXAMPLES
403
435
  $ swaggerhub api:update organization/api/1.0.0 --visibility=private
404
436
  ```
405
437
 
406
- _See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/api/update.js)_
438
+ _See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/api/update.js)_
407
439
 
408
440
  ## `swaggerhub api:validate`
409
441
 
@@ -414,7 +446,7 @@ USAGE
414
446
  $ swaggerhub api:validate OWNER/API_NAME/[VERSION] [-c] [-j] [-h]
415
447
 
416
448
  ARGUMENTS
417
- OWNER/API_NAME/[VERSION] API to fetch validation errors for from Swaggerhub
449
+ OWNER/API_NAME/[VERSION] API to fetch validation errors for
418
450
 
419
451
  FLAGS
420
452
  -c, --fail-on-critical Exit with error code 1 if there are critical standardization errors present
@@ -425,7 +457,7 @@ DESCRIPTION
425
457
  Get validation result for an API version
426
458
  When VERSION is not included in the argument, the default version will be validated.
427
459
  An error will occur if the API version does not exist.
428
- If the flag `-c` or `--failOnCritical` is used and there are standardization
460
+ If the flag `-c` or `--fail-on-critical` is used and there are standardization
429
461
  errors with `Critical` severity present, the command will exit with error code `1`.
430
462
 
431
463
 
@@ -437,18 +469,18 @@ EXAMPLES
437
469
  $ swaggerhub api:validate --fail-on-critical --json organization/api
438
470
  ```
439
471
 
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)_
472
+ _See code: [src/commands/api/validate/index.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/api/validate/index.js)_
441
473
 
442
474
  ## `swaggerhub api:validate:download-rules`
443
475
 
444
- Get existing SwaggerHub's organization standardization ruleset.
476
+ Get an organization's existing standardization ruleset from Swagger.
445
477
 
446
478
  ```
447
479
  USAGE
448
480
  $ swaggerhub api:validate:download-rules OWNER [-s] [-d] [-h]
449
481
 
450
482
  ARGUMENTS
451
- OWNER Which organization standardization rules to fetch from SwaggerHub
483
+ OWNER Which organization standardization rules to fetch from Swagger
452
484
 
453
485
  FLAGS
454
486
  -d, --include-disabled-rules Includes disabled rules in fetched organization's ruleset
@@ -456,11 +488,11 @@ FLAGS
456
488
  -s, --include-system-rules Includes system rules in fetched organization's ruleset
457
489
 
458
490
  DESCRIPTION
459
- Get existing SwaggerHub's organization standardization ruleset.
460
- Requires organization name argument. An error will occur if provided organization doesn't exist
491
+ Get an organization's existing standardization ruleset from Swagger.
492
+ Requires organization name argument. An error will occur if the provided organization doesn't exist
461
493
  or your account is not permitted to access that organization's settings.
462
- If the flag `-s` or `--include-system-rules` is used, the returned ruleset will also include SwaggerHub system rules.
463
- If the flag `-d` or `--include-disabled-rules` is used, the returned ruleset will also include disabled custom rules
494
+ If the flag `-s` or `--include-system-rules` is used, the returned ruleset will also include Swagger system rules.
495
+ If the flag `-d` or `--include-disabled-rules` is used, the returned ruleset will also include disabled custom rules.
464
496
 
465
497
  EXAMPLES
466
498
  $ swaggerhub api:validate:download-rules myOrg -s
@@ -468,11 +500,11 @@ EXAMPLES
468
500
  $ swaggerhub api:validate:download-rules myOrg --include-disabled-rules -s
469
501
  ```
470
502
 
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)_
503
+ _See code: [src/commands/api/validate/download-rules.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/api/validate/download-rules.js)_
472
504
 
473
505
  ## `swaggerhub api:validate:local`
474
506
 
475
- Runs a scan against a local API definition using the organization's standardization configuration on SwaggerHub.
507
+ Runs a scan against a local API definition using the organization's standardization configuration on Swagger.
476
508
 
477
509
  ```
478
510
  USAGE
@@ -487,18 +519,18 @@ FLAGS
487
519
  definition
488
520
 
489
521
  DESCRIPTION
490
- Runs a scan against a local API definition using the organization's standardization configuration on SwaggerHub.
491
- If the flag `-c` or `--failOnCritical` is used and there are standardization
522
+ Runs a scan against a local API definition using the organization's standardization configuration on Swagger.
523
+ If the flag `-c` or `--fail-on-critical` is used and there are standardization
492
524
  errors with `Critical` severity present, the command will exit with error code `1`.
493
525
 
494
526
 
495
527
  EXAMPLES
496
528
  $ swaggerhub api:validate:local -o myOrg -f ./my-api.yaml -c -j
497
529
 
498
- $ swaggerhub api:validate:local --organization myOrg --file ./my-api/json --fail-on-critical --json
530
+ $ swaggerhub api:validate:local --organization myOrg --file ./my-api.json --fail-on-critical --json
499
531
  ```
500
532
 
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)_
533
+ _See code: [src/commands/api/validate/local.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/api/validate/local.js)_
502
534
 
503
535
  ## `swaggerhub configure`
504
536
 
@@ -513,15 +545,43 @@ FLAGS
513
545
 
514
546
  DESCRIPTION
515
547
  configure application settings
516
- Enter the SwaggerHub URL - default is https://api.swaggerhub.com
517
- Customers with on-premise installations need to point this to their on-premise API, which is
548
+ Enter the Swagger URL - default is https://api.swaggerhub.com
549
+ Customers with on-premise installations (version 2.x) need to point this to their on-premise API, which is
518
550
  http(s)://{swaggerhub-host}/v1
519
551
  Enter the API Key - this can be retrieved from https://app.swaggerhub.com/settings/apiKey
520
552
  You can set these as environment variables: SWAGGERHUB_URL, SWAGGERHUB_API_KEY. These take priority over config
521
553
  settings.
522
554
  ```
523
555
 
524
- _See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/configure.js)_
556
+ _See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/configure.js)_
557
+
558
+ ## `swaggerhub domain:clone`
559
+
560
+ clone a domain version as a new version
561
+
562
+ ```
563
+ USAGE
564
+ $ swaggerhub domain:clone OWNER/DOMAIN_NAME/VERSION NEW_VERSION [--visibility public|private] [-h]
565
+
566
+ ARGUMENTS
567
+ OWNER/DOMAIN_NAME/VERSION Domain version to clone
568
+ NEW_VERSION Version identifier of the new domain version
569
+
570
+ FLAGS
571
+ -h, --help Show CLI help.
572
+ --visibility=<option> visibility of the new version (defaults to the server setting)
573
+ <options: public|private>
574
+
575
+ DESCRIPTION
576
+ clone a domain version as a new version
577
+
578
+ EXAMPLES
579
+ $ swaggerhub domain:clone organization/domain/1.0.0 1.0.1
580
+
581
+ $ swaggerhub domain:clone organization/domain/1.0.0 1.0.1 --visibility public
582
+ ```
583
+
584
+ _See code: [src/commands/domain/clone.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/domain/clone.js)_
525
585
 
526
586
  ## `swaggerhub domain:create`
527
587
 
@@ -533,7 +593,7 @@ USAGE
533
593
  publish|unpublish -f <value>) [--setdefault ] [-h]
534
594
 
535
595
  ARGUMENTS
536
- OWNER/DOMAIN_NAME/[VERSION] Domain to create on SwaggerHub
596
+ OWNER/DOMAIN_NAME/[VERSION] Domain to create on Swagger
537
597
 
538
598
  FLAGS
539
599
  -f, --file=<value> (required) file location of domain to create
@@ -541,7 +601,7 @@ FLAGS
541
601
  --published=<option> [default: unpublish] sets the lifecycle setting of the domain version
542
602
  <options: publish|unpublish>
543
603
  --setdefault sets domain version to be the default
544
- --visibility=<option> [default: private] visibility of domain in SwaggerHub
604
+ --visibility=<option> [default: private] visibility of domain in Swagger
545
605
  <options: public|private>
546
606
 
547
607
  DESCRIPTION
@@ -555,14 +615,14 @@ EXAMPLES
555
615
 
556
616
  $ swaggerhub domain:create organization/domain --file domain.yaml
557
617
 
558
- $ swaggerhub domain:create organization/domain/1.0.0 --publish --file domain.json
618
+ $ swaggerhub domain:create organization/domain/1.0.0 --published=publish --file domain.json
559
619
 
560
620
  $ swaggerhub domain:create organization/domain/1.0.0 --setdefault --file domain.json
561
621
 
562
- $ swaggerhub domain:create organization/domain/1.0.0 --publish --setdefault --file domain.json
622
+ $ swaggerhub domain:create organization/domain/1.0.0 --published=publish --setdefault --file domain.json
563
623
  ```
564
624
 
565
- _See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/create.js)_
625
+ _See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/domain/create.js)_
566
626
 
567
627
  ## `swaggerhub domain:delete`
568
628
 
@@ -573,7 +633,7 @@ USAGE
573
633
  $ swaggerhub domain:delete OWNER/DOMAIN_NAME/[VERSION] [-f] [-h]
574
634
 
575
635
  ARGUMENTS
576
- OWNER/DOMAIN_NAME/[VERSION] Domain to delete on SwaggerHub
636
+ OWNER/DOMAIN_NAME/[VERSION] Domain to delete on Swagger
577
637
 
578
638
  FLAGS
579
639
  -f, --force delete domain without prompting for confirmation
@@ -591,7 +651,7 @@ EXAMPLES
591
651
  $ swaggerhub domain:delete organization/domain --force
592
652
  ```
593
653
 
594
- _See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/delete.js)_
654
+ _See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/domain/delete.js)_
595
655
 
596
656
  ## `swaggerhub domain:get`
597
657
 
@@ -602,7 +662,7 @@ USAGE
602
662
  $ swaggerhub domain:get OWNER/DOMAIN_NAME/[VERSION] [-j] [-h]
603
663
 
604
664
  ARGUMENTS
605
- OWNER/DOMAIN_NAME/[VERSION] Domain to fetch from SwaggerHub
665
+ OWNER/DOMAIN_NAME/[VERSION] Domain to fetch from Swagger
606
666
 
607
667
  FLAGS
608
668
  -h, --help Show CLI help.
@@ -620,7 +680,7 @@ EXAMPLES
620
680
  $ swaggerhub domain:get organization/domain/1.0.0 --json
621
681
  ```
622
682
 
623
- _See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/get.js)_
683
+ _See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/domain/get.js)_
624
684
 
625
685
  ## `swaggerhub domain:publish`
626
686
 
@@ -631,7 +691,7 @@ USAGE
631
691
  $ swaggerhub domain:publish OWNER/DOMAIN_NAME/VERSION [-f] [-h]
632
692
 
633
693
  ARGUMENTS
634
- OWNER/DOMAIN_NAME/VERSION Domain to publish on SwaggerHub
694
+ OWNER/DOMAIN_NAME/VERSION Domain to publish on Swagger
635
695
 
636
696
  FLAGS
637
697
  -f, --force publish domain without prompting for confirmation
@@ -646,7 +706,34 @@ EXAMPLES
646
706
  $ swaggerhub domain:publish organization/domain/1.0.0 --force
647
707
  ```
648
708
 
649
- _See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/publish.js)_
709
+ _See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/domain/publish.js)_
710
+
711
+ ## `swaggerhub domain:rename`
712
+
713
+ rename a domain
714
+
715
+ ```
716
+ USAGE
717
+ $ swaggerhub domain:rename OWNER/DOMAIN_NAME DOMAIN_NEW_NAME [-f] [-h]
718
+
719
+ ARGUMENTS
720
+ OWNER/DOMAIN_NAME Domain to be renamed
721
+ DOMAIN_NEW_NAME New name for the domain
722
+
723
+ FLAGS
724
+ -f, --force rename the domain even if it is referenced by APIs or other domains
725
+ -h, --help Show CLI help.
726
+
727
+ DESCRIPTION
728
+ rename a domain
729
+
730
+ EXAMPLES
731
+ $ swaggerhub domain:rename organization/domainOldName domainNewName
732
+
733
+ $ swaggerhub domain:rename organization/domainOldName domainNewName --force
734
+ ```
735
+
736
+ _See code: [src/commands/domain/rename.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/domain/rename.js)_
650
737
 
651
738
  ## `swaggerhub domain:setdefault`
652
739
 
@@ -657,7 +744,7 @@ USAGE
657
744
  $ swaggerhub domain:setdefault OWNER/DOMAIN_NAME/VERSION [-h]
658
745
 
659
746
  ARGUMENTS
660
- OWNER/DOMAIN_NAME/VERSION Domain to set as default on SwaggerHub
747
+ OWNER/DOMAIN_NAME/VERSION Domain to set as default on Swagger
661
748
 
662
749
  FLAGS
663
750
  -h, --help Show CLI help.
@@ -669,7 +756,7 @@ EXAMPLES
669
756
  $ swaggerhub domain:setdefault organization/domain/2.0.0
670
757
  ```
671
758
 
672
- _See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/setdefault.js)_
759
+ _See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/domain/setdefault.js)_
673
760
 
674
761
  ## `swaggerhub domain:unpublish`
675
762
 
@@ -680,7 +767,7 @@ USAGE
680
767
  $ swaggerhub domain:unpublish OWNER/DOMAIN_NAME/VERSION [-h]
681
768
 
682
769
  ARGUMENTS
683
- OWNER/DOMAIN_NAME/VERSION Domain to unpublish on SwaggerHub
770
+ OWNER/DOMAIN_NAME/VERSION Domain to unpublish on Swagger
684
771
 
685
772
  FLAGS
686
773
  -h, --help Show CLI help.
@@ -692,7 +779,7 @@ EXAMPLES
692
779
  $ swaggerhub domain:unpublish organization/domain/1.0.0
693
780
  ```
694
781
 
695
- _See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/unpublish.js)_
782
+ _See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/domain/unpublish.js)_
696
783
 
697
784
  ## `swaggerhub domain:update`
698
785
 
@@ -704,7 +791,7 @@ USAGE
704
791
  publish|unpublish] [--setdefault] [-h]
705
792
 
706
793
  ARGUMENTS
707
- OWNER/DOMAIN_NAME/[VERSION] Domain to update on SwaggerHub
794
+ OWNER/DOMAIN_NAME/[VERSION] Domain to update on Swagger
708
795
 
709
796
  FLAGS
710
797
  -f, --file=<value> file location of domain to update
@@ -712,14 +799,14 @@ FLAGS
712
799
  --published=<option> sets the lifecycle setting of the domain version
713
800
  <options: publish|unpublish>
714
801
  --setdefault sets domain version to be the default
715
- --visibility=<option> visibility of domain in SwaggerHub
802
+ --visibility=<option> visibility of domain in Swagger
716
803
  <options: public|private>
717
804
 
718
805
  DESCRIPTION
719
806
  update a domain
720
807
  The domain version from the file will be used unless the version is specified in the command argument.
721
808
  When no file is specified then the default domain version will be updated.
722
- The domain visibility can be changed by using visibility flag.
809
+ The domain visibility can be changed by using the --visibility flag.
723
810
 
724
811
 
725
812
  EXAMPLES
@@ -736,7 +823,7 @@ EXAMPLES
736
823
  $ swaggerhub domain:update organization/domain/1.0.0 --visibility=private
737
824
  ```
738
825
 
739
- _See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/domain/update.js)_
826
+ _See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/domain/update.js)_
740
827
 
741
828
  ## `swaggerhub help`
742
829
 
@@ -767,7 +854,7 @@ USAGE
767
854
  $ swaggerhub integration:create OWNER/API_NAME/[VERSION] -f <value> [-h]
768
855
 
769
856
  ARGUMENTS
770
- OWNER/API_NAME/[VERSION] API to add integration to on SwaggerHub
857
+ OWNER/API_NAME/[VERSION] API to add integration to on Swagger
771
858
 
772
859
  FLAGS
773
860
  -f, --file=<value> (required) location of integration configuration file
@@ -777,14 +864,14 @@ DESCRIPTION
777
864
  creates a new API integration from a JSON configuration file.
778
865
  See the documentation for configuration files:
779
866
  https://github.com/SmartBear/swaggerhub-cli/tree/main/examples/integrations
780
- When VERSION is not included in the argument, the integration will be added to be default API version.
867
+ When VERSION is not included in the argument, the integration will be added to the default API version.
781
868
 
782
869
 
783
870
  EXAMPLES
784
871
  $ swaggerhub integration:create organization/api/1.0.0 --file config.json
785
872
  ```
786
873
 
787
- _See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/integration/create.js)_
874
+ _See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/integration/create.js)_
788
875
 
789
876
  ## `swaggerhub integration:delete`
790
877
 
@@ -795,7 +882,7 @@ USAGE
795
882
  $ swaggerhub integration:delete OWNER/API_NAME/VERSION/INTEGRATION_ID [-h]
796
883
 
797
884
  ARGUMENTS
798
- OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to delete for given API on Swaggerhub
885
+ OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to delete for given API on Swagger
799
886
 
800
887
  FLAGS
801
888
  -h, --help Show CLI help.
@@ -807,7 +894,7 @@ EXAMPLES
807
894
  $ swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
808
895
  ```
809
896
 
810
- _See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/integration/delete.js)_
897
+ _See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/integration/delete.js)_
811
898
 
812
899
  ## `swaggerhub integration:execute`
813
900
 
@@ -818,7 +905,7 @@ USAGE
818
905
  $ swaggerhub integration:execute OWNER/API_NAME/VERSION/INTEGRATION_ID [-h]
819
906
 
820
907
  ARGUMENTS
821
- OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to execute for given API on Swaggerhub
908
+ OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to execute for given API on Swagger
822
909
 
823
910
  FLAGS
824
911
  -h, --help Show CLI help.
@@ -830,30 +917,30 @@ EXAMPLES
830
917
  $ swaggerhub integration:execute organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
831
918
  ```
832
919
 
833
- _See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/integration/execute.js)_
920
+ _See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/integration/execute.js)_
834
921
 
835
922
  ## `swaggerhub integration:get`
836
923
 
837
- retieves an integration for the given API.
924
+ retrieves an integration for the given API.
838
925
 
839
926
  ```
840
927
  USAGE
841
928
  $ swaggerhub integration:get OWNER/API_NAME/VERSION/INTEGRATION_ID [-h]
842
929
 
843
930
  ARGUMENTS
844
- OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to fetch for given API on Swaggerhub
931
+ OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to fetch for given API on Swagger
845
932
 
846
933
  FLAGS
847
934
  -h, --help Show CLI help.
848
935
 
849
936
  DESCRIPTION
850
- retieves an integration for the given API.
937
+ retrieves an integration for the given API.
851
938
 
852
939
  EXAMPLES
853
940
  $ swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
854
941
  ```
855
942
 
856
- _See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/integration/get.js)_
943
+ _See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/integration/get.js)_
857
944
 
858
945
  ## `swaggerhub integration:list`
859
946
 
@@ -864,7 +951,7 @@ USAGE
864
951
  $ swaggerhub integration:list OWNER/API_NAME/[VERSION] [-h]
865
952
 
866
953
  ARGUMENTS
867
- OWNER/API_NAME/[VERSION] API to list integrations for on Swaggerhub
954
+ OWNER/API_NAME/[VERSION] API to list integrations for
868
955
 
869
956
  FLAGS
870
957
  -h, --help Show CLI help.
@@ -876,7 +963,7 @@ EXAMPLES
876
963
  $ swaggerhub integration:list organization/api/1.0.0
877
964
  ```
878
965
 
879
- _See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/integration/list.js)_
966
+ _See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/integration/list.js)_
880
967
 
881
968
  ## `swaggerhub integration:update`
882
969
 
@@ -887,7 +974,7 @@ USAGE
887
974
  $ swaggerhub integration:update OWNER/API_NAME/VERSION/INTEGRATION_ID -f <value> [-h]
888
975
 
889
976
  ARGUMENTS
890
- OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to update for given API on Swaggerhub
977
+ OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to update for given API on Swagger
891
978
 
892
979
  FLAGS
893
980
  -f, --file=<value> (required) location of integration configuration file
@@ -900,7 +987,7 @@ EXAMPLES
900
987
  $ swaggerhub integration:update organization/api/1.0.0/503c2db6-448a-4678-abcd-0123456789abc --file config.json
901
988
  ```
902
989
 
903
- _See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/integration/update.js)_
990
+ _See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/integration/update.js)_
904
991
 
905
992
  ## `swaggerhub plugins`
906
993
 
@@ -1201,8 +1288,8 @@ USAGE
1201
1288
  $ swaggerhub project:api:add OWNER/PROJECT_NAME API [-h]
1202
1289
 
1203
1290
  ARGUMENTS
1204
- OWNER/PROJECT_NAME The project to add the API to on Swaggerhub
1205
- API The name of the API on Swaggerhub to add
1291
+ OWNER/PROJECT_NAME The project to add the API to on Swagger
1292
+ API The name of the API on Swagger to add
1206
1293
 
1207
1294
  FLAGS
1208
1295
  -h, --help Show CLI help.
@@ -1214,51 +1301,51 @@ EXAMPLES
1214
1301
  $ swaggerhub project:api:add organization/project_name my_api
1215
1302
  ```
1216
1303
 
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)_
1304
+ _See code: [src/commands/project/api/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/project/api/add.js)_
1218
1305
 
1219
1306
  ## `swaggerhub project:api:remove`
1220
1307
 
1221
- Removes an API from a project in SwaggerHub.
1308
+ Removes an API from a project in Swagger.
1222
1309
 
1223
1310
  ```
1224
1311
  USAGE
1225
1312
  $ swaggerhub project:api:remove OWNER/PROJECT_NAME API [-h]
1226
1313
 
1227
1314
  ARGUMENTS
1228
- OWNER/PROJECT_NAME The project to remove the API from on Swaggerhub
1229
- API The name of the API on Swaggerhub to remove
1315
+ OWNER/PROJECT_NAME The project to remove the API from on Swagger
1316
+ API The name of the API on Swagger to remove
1230
1317
 
1231
1318
  FLAGS
1232
1319
  -h, --help Show CLI help.
1233
1320
 
1234
1321
  DESCRIPTION
1235
- Removes an API from a project in SwaggerHub.
1322
+ Removes an API from a project in Swagger.
1236
1323
 
1237
1324
  EXAMPLES
1238
1325
  $ swaggerhub project:api:remove organization/project_name my_api
1239
1326
  ```
1240
1327
 
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)_
1328
+ _See code: [src/commands/project/api/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/project/api/remove.js)_
1242
1329
 
1243
1330
  ## `swaggerhub project:create`
1244
1331
 
1245
- Creates a new project in SwaggerHub.
1332
+ Creates a new project in Swagger.
1246
1333
 
1247
1334
  ```
1248
1335
  USAGE
1249
1336
  $ swaggerhub project:create OWNER/PROJECT_NAME [--description <value>] [-a <value>] [-d <value>] [-h]
1250
1337
 
1251
1338
  ARGUMENTS
1252
- OWNER/PROJECT_NAME The new project to create on Swaggerhub
1339
+ OWNER/PROJECT_NAME The new project to create on Swagger
1253
1340
 
1254
1341
  FLAGS
1255
- -a, --apis=<value> Comma separated list of api names to include in project
1256
- -d, --domains=<value> Comma separated list of domain names to include in project
1342
+ -a, --apis=<value> Comma-separated list of API names to include in project
1343
+ -d, --domains=<value> Comma-separated list of domain names to include in project
1257
1344
  -h, --help Show CLI help.
1258
1345
  --description=<value> Description of project
1259
1346
 
1260
1347
  DESCRIPTION
1261
- Creates a new project in SwaggerHub.
1348
+ Creates a new project in Swagger.
1262
1349
 
1263
1350
  EXAMPLES
1264
1351
  $ swaggerhub project:create organization/new_project_name --description "project description"
@@ -1274,30 +1361,30 @@ EXAMPLES
1274
1361
  $ swaggerhub project:create organization/new_project_name -a "testapi1" -d "testdomain3" --description "description"
1275
1362
  ```
1276
1363
 
1277
- _See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/project/create.js)_
1364
+ _See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/project/create.js)_
1278
1365
 
1279
1366
  ## `swaggerhub project:delete`
1280
1367
 
1281
- Deletes a project from SwaggerHub.
1368
+ Deletes a project from Swagger.
1282
1369
 
1283
1370
  ```
1284
1371
  USAGE
1285
1372
  $ swaggerhub project:delete OWNER/PROJECT_NAME [-h]
1286
1373
 
1287
1374
  ARGUMENTS
1288
- OWNER/PROJECT_NAME The project to delete on Swaggerhub
1375
+ OWNER/PROJECT_NAME The project to delete on Swagger
1289
1376
 
1290
1377
  FLAGS
1291
1378
  -h, --help Show CLI help.
1292
1379
 
1293
1380
  DESCRIPTION
1294
- Deletes a project from SwaggerHub.
1381
+ Deletes a project from Swagger.
1295
1382
 
1296
1383
  EXAMPLES
1297
1384
  $ swaggerhub project:delete organization/project_name
1298
1385
  ```
1299
1386
 
1300
- _See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/project/delete.js)_
1387
+ _See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/project/delete.js)_
1301
1388
 
1302
1389
  ## `swaggerhub project:domain:add`
1303
1390
 
@@ -1308,8 +1395,8 @@ USAGE
1308
1395
  $ swaggerhub project:domain:add OWNER/PROJECT_NAME DOMAIN [-h]
1309
1396
 
1310
1397
  ARGUMENTS
1311
- OWNER/PROJECT_NAME The project to add the domain to on Swaggerhub
1312
- DOMAIN The name of the domain on Swaggerhub to add
1398
+ OWNER/PROJECT_NAME The project to add the domain to on Swagger
1399
+ DOMAIN The name of the domain on Swagger to add
1313
1400
 
1314
1401
  FLAGS
1315
1402
  -h, --help Show CLI help.
@@ -1321,31 +1408,31 @@ EXAMPLES
1321
1408
  $ swaggerhub project:domain:add organization/project_name my_domain
1322
1409
  ```
1323
1410
 
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)_
1411
+ _See code: [src/commands/project/domain/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/project/domain/add.js)_
1325
1412
 
1326
1413
  ## `swaggerhub project:domain:remove`
1327
1414
 
1328
- Removes a domain from a project in SwaggerHub.
1415
+ Removes a domain from a project in Swagger.
1329
1416
 
1330
1417
  ```
1331
1418
  USAGE
1332
1419
  $ swaggerhub project:domain:remove OWNER/PROJECT_NAME DOMAIN [-h]
1333
1420
 
1334
1421
  ARGUMENTS
1335
- OWNER/PROJECT_NAME The project to remove the domain from on Swaggerhub
1336
- DOMAIN The name of the domain on Swaggerhub to remove
1422
+ OWNER/PROJECT_NAME The project to remove the domain from on Swagger
1423
+ DOMAIN The name of the domain on Swagger to remove
1337
1424
 
1338
1425
  FLAGS
1339
1426
  -h, --help Show CLI help.
1340
1427
 
1341
1428
  DESCRIPTION
1342
- Removes a domain from a project in SwaggerHub.
1429
+ Removes a domain from a project in Swagger.
1343
1430
 
1344
1431
  EXAMPLES
1345
1432
  $ swaggerhub project:domain:remove organization/project_name my_domain
1346
1433
  ```
1347
1434
 
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)_
1435
+ _See code: [src/commands/project/domain/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/project/domain/remove.js)_
1349
1436
 
1350
1437
  ## `swaggerhub project:get`
1351
1438
 
@@ -1356,7 +1443,7 @@ USAGE
1356
1443
  $ swaggerhub project:get OWNER/PROJECT_NAME [-h]
1357
1444
 
1358
1445
  ARGUMENTS
1359
- OWNER/PROJECT_NAME The project to get details for on Swaggerhub
1446
+ OWNER/PROJECT_NAME The project to get details for on Swagger
1360
1447
 
1361
1448
  FLAGS
1362
1449
  -h, --help Show CLI help.
@@ -1368,7 +1455,7 @@ EXAMPLES
1368
1455
  $ swaggerhub project:get organization/project_name
1369
1456
  ```
1370
1457
 
1371
- _See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/project/get.js)_
1458
+ _See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/project/get.js)_
1372
1459
 
1373
1460
  ## `swaggerhub project:list`
1374
1461
 
@@ -1379,7 +1466,7 @@ USAGE
1379
1466
  $ swaggerhub project:list [OWNER] [-h] [-l <value>] [--page <value>] [--order ASC|DESC]
1380
1467
 
1381
1468
  ARGUMENTS
1382
- OWNER The organization to list projects for on Swaggerhub
1469
+ OWNER The organization to list projects for on Swagger
1383
1470
 
1384
1471
  FLAGS
1385
1472
  -h, --help Show CLI help.
@@ -1401,7 +1488,7 @@ EXAMPLES
1401
1488
  $ swaggerhub project:list organization --page 2 --limit 20
1402
1489
  ```
1403
1490
 
1404
- _See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/project/list.js)_
1491
+ _See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/project/list.js)_
1405
1492
 
1406
1493
  ## `swaggerhub project:member:list`
1407
1494
 
@@ -1412,7 +1499,7 @@ USAGE
1412
1499
  $ swaggerhub project:member:list OWNER/PROJECT_NAME [-h]
1413
1500
 
1414
1501
  ARGUMENTS
1415
- OWNER/PROJECT_NAME Project to list members of on Swaggerhub
1502
+ OWNER/PROJECT_NAME Project to list members of
1416
1503
 
1417
1504
  FLAGS
1418
1505
  -h, --help Show CLI help.
@@ -1421,10 +1508,10 @@ DESCRIPTION
1421
1508
  list members of a project
1422
1509
 
1423
1510
  EXAMPLES
1424
- $ swaggerhub project:member:list organisation/project_name
1511
+ $ swaggerhub project:member:list organization/project_name
1425
1512
  ```
1426
1513
 
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)_
1514
+ _See code: [src/commands/project/member/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/project/member/list.js)_
1428
1515
 
1429
1516
  ## `swaggerhub spectral:download`
1430
1517
 
@@ -1435,7 +1522,7 @@ USAGE
1435
1522
  $ swaggerhub spectral:download OWNER/RULESET_NAME DIRECTORY [-h]
1436
1523
 
1437
1524
  ARGUMENTS
1438
- OWNER/RULESET_NAME Organization's Spectral ruleset to create or update on SwaggerHub
1525
+ OWNER/RULESET_NAME Organization's Spectral ruleset to create or update on Swagger
1439
1526
  DIRECTORY Relative path to directory the ruleset files should be saved to
1440
1527
 
1441
1528
  FLAGS
@@ -1448,7 +1535,7 @@ EXAMPLES
1448
1535
  $ swaggerhub spectral:download my_organization/my_api_ruleset rules/
1449
1536
  ```
1450
1537
 
1451
- _See code: [src/commands/spectral/download.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/spectral/download.js)_
1538
+ _See code: [src/commands/spectral/download.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/spectral/download.js)_
1452
1539
 
1453
1540
  ## `swaggerhub spectral:upload`
1454
1541
 
@@ -1459,7 +1546,7 @@ USAGE
1459
1546
  $ swaggerhub spectral:upload OWNER/RULESET_NAME DIRECTORY [-h]
1460
1547
 
1461
1548
  ARGUMENTS
1462
- OWNER/RULESET_NAME Organization's Spectral ruleset to create or update on SwaggerHub
1549
+ OWNER/RULESET_NAME Organization's Spectral ruleset to create or update on Swagger
1463
1550
  DIRECTORY Relative path to directory with ruleset files
1464
1551
 
1465
1552
  FLAGS
@@ -1472,12 +1559,12 @@ EXAMPLES
1472
1559
  $ swaggerhub spectral:upload my_organization/my_api_ruleset rules/
1473
1560
  ```
1474
1561
 
1475
- _See code: [src/commands/spectral/upload.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.13.0/src/commands/spectral/upload.js)_
1562
+ _See code: [src/commands/spectral/upload.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.15.0/src/commands/spectral/upload.js)_
1476
1563
  <!-- commandsstop -->
1477
1564
 
1478
1565
  # Plugins
1479
1566
 
1480
- The SwaggerHub CLI supports plugins via the [oclif plugin](https://oclif.io/docs/plugins) infrastructure.
1567
+ The Swagger CLI supports plugins via the [oclif plugin](https://oclif.io/docs/plugins) infrastructure.
1481
1568
 
1482
1569
  To install a plugin
1483
1570
 
@@ -1514,5 +1601,5 @@ $ swaggerhub schema:get ansible
1514
1601
 
1515
1602
  # Contributing
1516
1603
  <!-- contributing -->
1517
- The SwaggerHub CLI is currently in an active development phase—we will not be accepting Pull Requests at this time. If you’ve found any bugs or typos, or have a feature requests or general feedback you’d like to share, please open an [issue](https://github.com/SmartBear/swaggerhub-cli/issues) and let us know.
1604
+ Contributions are welcome. If you’ve found a bug or a typo, or have a feature request or general feedback, please open an [issue](https://github.com/SmartBear/swaggerhub-cli/issues). Pull requests are welcome too; for larger changes, please open an issue first so we can discuss the approach.
1518
1605
  <!-- contributingstop -->