swaggerhub-cli 0.6.5 → 0.7.1
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 +535 -291
- package/bin/run +3 -3
- package/oclif.manifest.json +1165 -1
- package/package.json +19 -26
- package/src/commands/api/create.js +12 -11
- package/src/commands/api/delete.js +9 -8
- package/src/commands/api/get.js +10 -9
- package/src/commands/api/publish.js +12 -9
- package/src/commands/api/setdefault.js +8 -6
- package/src/commands/api/unpublish.js +8 -6
- package/src/commands/api/update.js +12 -11
- package/src/commands/api/validate.js +31 -13
- package/src/commands/domain/create.js +12 -11
- package/src/commands/domain/delete.js +9 -8
- package/src/commands/domain/get.js +9 -8
- package/src/commands/domain/publish.js +8 -6
- package/src/commands/domain/setdefault.js +8 -6
- package/src/commands/domain/unpublish.js +8 -6
- package/src/commands/domain/update.js +12 -11
- package/src/commands/integration/create.js +10 -9
- package/src/commands/integration/delete.js +8 -6
- package/src/commands/integration/execute.js +8 -6
- package/src/commands/integration/get.js +8 -6
- package/src/commands/integration/list.js +11 -10
- package/src/commands/integration/update.js +9 -8
- package/src/commands/project/api/add.js +10 -12
- package/src/commands/project/api/remove.js +10 -11
- package/src/commands/project/create.js +11 -10
- package/src/commands/project/delete.js +8 -6
- package/src/commands/project/domain/add.js +10 -12
- package/src/commands/project/domain/remove.js +10 -11
- package/src/commands/project/get.js +8 -6
- package/src/commands/project/list.js +10 -9
- package/src/commands/project/member/list.js +10 -9
- package/src/config/index.js +1 -2
- package/src/help.js +1 -1
- package/src/index.js +2 -1
- package/src/support/command/base-command.js +2 -2
- package/src/support/command/handle-response.js +1 -1
- package/src/support/command/parse-input.js +1 -1
- package/src/support/command/update-command.js +1 -1
- package/src/support/http/index.js +1 -3
- package/src/support/isOnPrem.js +10 -0
- package/src/utils/definitions.js +4 -2
- package/src/utils/general.js +29 -1
package/README.md
CHANGED
|
@@ -16,9 +16,8 @@ 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
|
|
19
|
+
Node.js 16.x or later.
|
|
20
20
|
|
|
21
|
-
*NOTE:* `swaggerhub-cli v0.6.4` *will be the last release to support Node 12.x and support will be dropped in a future version.*
|
|
22
21
|
# Installation
|
|
23
22
|
```sh-session
|
|
24
23
|
$ npm i -g swaggerhub-cli
|
|
@@ -119,7 +118,7 @@ USAGE
|
|
|
119
118
|
* [`swaggerhub domain:setdefault OWNER/DOMAIN_NAME/VERSION`](#swaggerhub-domainsetdefault)
|
|
120
119
|
* [`swaggerhub domain:unpublish OWNER/DOMAIN_NAME/VERSION`](#swaggerhub-domainunpublish)
|
|
121
120
|
* [`swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION]`](#swaggerhub-domainupdate)
|
|
122
|
-
* [`swaggerhub help [
|
|
121
|
+
* [`swaggerhub help [COMMANDS]`](#swaggerhub-help)
|
|
123
122
|
* [`swaggerhub integration:create OWNER/API_NAME/[VERSION]`](#swaggerhub-integrationcreate)
|
|
124
123
|
* [`swaggerhub integration:delete OWNER/API_NAME/VERSION/INTEGRATION_ID`](#swaggerhub-integrationdelete)
|
|
125
124
|
* [`swaggerhub integration:execute OWNER/API_NAME/VERSION/INTEGRATION_ID`](#swaggerhub-integrationexecute)
|
|
@@ -127,10 +126,13 @@ USAGE
|
|
|
127
126
|
* [`swaggerhub integration:list OWNER/API_NAME/[VERSION]`](#swaggerhub-integrationlist)
|
|
128
127
|
* [`swaggerhub integration:update OWNER/API_NAME/VERSION/INTEGRATION_ID`](#swaggerhub-integrationupdate)
|
|
129
128
|
* [`swaggerhub plugins`](#swaggerhub-plugins)
|
|
129
|
+
* [`swaggerhub plugins:install PLUGIN...`](#swaggerhub-pluginsinstall)
|
|
130
130
|
* [`swaggerhub plugins:inspect PLUGIN...`](#swaggerhub-pluginsinspect)
|
|
131
131
|
* [`swaggerhub plugins:install PLUGIN...`](#swaggerhub-pluginsinstall)
|
|
132
132
|
* [`swaggerhub plugins:link PLUGIN`](#swaggerhub-pluginslink)
|
|
133
133
|
* [`swaggerhub plugins:uninstall PLUGIN...`](#swaggerhub-pluginsuninstall)
|
|
134
|
+
* [`swaggerhub plugins:uninstall PLUGIN...`](#swaggerhub-pluginsuninstall)
|
|
135
|
+
* [`swaggerhub plugins:uninstall PLUGIN...`](#swaggerhub-pluginsuninstall)
|
|
134
136
|
* [`swaggerhub plugins:update`](#swaggerhub-pluginsupdate)
|
|
135
137
|
* [`swaggerhub project:api:add OWNER/PROJECT_NAME API`](#swaggerhub-projectapiadd)
|
|
136
138
|
* [`swaggerhub project:api:remove OWNER/PROJECT_NAME API`](#swaggerhub-projectapiremove)
|
|
@@ -148,31 +150,40 @@ creates a new API / API version from a YAML/JSON file
|
|
|
148
150
|
|
|
149
151
|
```
|
|
150
152
|
USAGE
|
|
151
|
-
$ swaggerhub api:create OWNER/API_NAME/[VERSION]
|
|
153
|
+
$ swaggerhub api:create OWNER/API_NAME/[VERSION] [-h] [--visibility public|private] (--published
|
|
154
|
+
publish|unpublish -f <value>) [--setdefault ]
|
|
152
155
|
|
|
153
156
|
ARGUMENTS
|
|
154
|
-
OWNER/API_NAME/[VERSION] API to create
|
|
157
|
+
OWNER/API_NAME/[VERSION] API to create on SwaggerHub
|
|
155
158
|
|
|
156
|
-
|
|
157
|
-
-f, --file
|
|
158
|
-
-h, --help
|
|
159
|
-
--published
|
|
160
|
-
|
|
161
|
-
--
|
|
159
|
+
FLAGS
|
|
160
|
+
-f, --file=<value> (required) file location of API to create
|
|
161
|
+
-h, --help Show CLI help.
|
|
162
|
+
--published=<option> [default: unpublish] sets the lifecycle setting of the API version
|
|
163
|
+
<options: publish|unpublish>
|
|
164
|
+
--setdefault sets API version to be the default
|
|
165
|
+
--visibility=<option> [default: private] visibility of API in SwaggerHub
|
|
166
|
+
<options: public|private>
|
|
162
167
|
|
|
163
168
|
DESCRIPTION
|
|
169
|
+
creates a new API / API version from a YAML/JSON file
|
|
164
170
|
The API version from the file will be used unless the version is specified in the command argument.
|
|
165
171
|
An error will occur if the API version already exists.
|
|
166
172
|
|
|
173
|
+
|
|
167
174
|
EXAMPLES
|
|
168
|
-
swaggerhub api:create organization/api/1.0.0 --file api.yaml --visibility public
|
|
169
|
-
|
|
170
|
-
swaggerhub api:create organization/api
|
|
171
|
-
|
|
172
|
-
swaggerhub api:create organization/api/1.0.0 --published=publish --
|
|
175
|
+
$ swaggerhub api:create organization/api/1.0.0 --file api.yaml --visibility public
|
|
176
|
+
|
|
177
|
+
$ swaggerhub api:create organization/api --file api.yaml
|
|
178
|
+
|
|
179
|
+
$ swaggerhub api:create organization/api/1.0.0 --published=publish --file api.json
|
|
180
|
+
|
|
181
|
+
$ swaggerhub api:create organization/api/1.0.0 --setdefault --file api.json
|
|
182
|
+
|
|
183
|
+
$ swaggerhub api:create organization/api/1.0.0 --published=publish --setdefault --file api.json
|
|
173
184
|
```
|
|
174
185
|
|
|
175
|
-
_See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
186
|
+
_See code: [src/commands/api/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/api/create.js)_
|
|
176
187
|
|
|
177
188
|
## `swaggerhub api:delete`
|
|
178
189
|
|
|
@@ -180,22 +191,28 @@ delete an API or API version
|
|
|
180
191
|
|
|
181
192
|
```
|
|
182
193
|
USAGE
|
|
183
|
-
$ swaggerhub api:delete OWNER/API_NAME/[VERSION]
|
|
194
|
+
$ swaggerhub api:delete OWNER/API_NAME/[VERSION] [-h] [-f]
|
|
184
195
|
|
|
185
196
|
ARGUMENTS
|
|
186
|
-
OWNER/API_NAME/[VERSION] API to delete
|
|
197
|
+
OWNER/API_NAME/[VERSION] API to delete on SwaggerHub
|
|
187
198
|
|
|
188
|
-
|
|
199
|
+
FLAGS
|
|
189
200
|
-f, --force delete API without prompting for confirmation
|
|
190
|
-
-h, --help
|
|
201
|
+
-h, --help Show CLI help.
|
|
202
|
+
|
|
203
|
+
DESCRIPTION
|
|
204
|
+
delete an API or API version
|
|
205
|
+
|
|
191
206
|
|
|
192
207
|
EXAMPLES
|
|
193
|
-
swaggerhub api:delete organization/api/1.0.0
|
|
194
|
-
|
|
195
|
-
swaggerhub api:delete organization/api
|
|
208
|
+
$ swaggerhub api:delete organization/api/1.0.0
|
|
209
|
+
|
|
210
|
+
$ swaggerhub api:delete organization/api
|
|
211
|
+
|
|
212
|
+
$ swaggerhub api:delete organization/api --force
|
|
196
213
|
```
|
|
197
214
|
|
|
198
|
-
_See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
215
|
+
_See code: [src/commands/api/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/api/delete.js)_
|
|
199
216
|
|
|
200
217
|
## `swaggerhub api:get`
|
|
201
218
|
|
|
@@ -203,26 +220,29 @@ fetches an API definition
|
|
|
203
220
|
|
|
204
221
|
```
|
|
205
222
|
USAGE
|
|
206
|
-
$ swaggerhub api:get OWNER/API_NAME/[VERSION]
|
|
223
|
+
$ swaggerhub api:get OWNER/API_NAME/[VERSION] [-h] [-j] [-r]
|
|
207
224
|
|
|
208
225
|
ARGUMENTS
|
|
209
|
-
OWNER/API_NAME/[VERSION]
|
|
226
|
+
OWNER/API_NAME/[VERSION] API to fetch from Swaggerhub
|
|
210
227
|
|
|
211
|
-
|
|
212
|
-
-h, --help
|
|
228
|
+
FLAGS
|
|
229
|
+
-h, --help Show CLI help.
|
|
213
230
|
-j, --json returns the API in JSON format.
|
|
214
231
|
-r, --resolved gets the resolved API definition (supported in v1.25+).
|
|
215
232
|
|
|
216
233
|
DESCRIPTION
|
|
234
|
+
fetches an API definition
|
|
217
235
|
When VERSION is not included in the argument, the default version will be returned.
|
|
218
236
|
Returns the API in YAML format by default.
|
|
219
237
|
|
|
238
|
+
|
|
220
239
|
EXAMPLES
|
|
221
|
-
swaggerhub api:get organization/api
|
|
222
|
-
|
|
240
|
+
$ swaggerhub api:get organization/api
|
|
241
|
+
|
|
242
|
+
$ swaggerhub api:get organization/api/1.0.0 --json
|
|
223
243
|
```
|
|
224
244
|
|
|
225
|
-
_See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
245
|
+
_See code: [src/commands/api/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/api/get.js)_
|
|
226
246
|
|
|
227
247
|
## `swaggerhub api:publish`
|
|
228
248
|
|
|
@@ -230,21 +250,25 @@ publish an API version
|
|
|
230
250
|
|
|
231
251
|
```
|
|
232
252
|
USAGE
|
|
233
|
-
$ swaggerhub api:publish OWNER/API_NAME/VERSION
|
|
253
|
+
$ swaggerhub api:publish OWNER/API_NAME/VERSION [-h] [-f]
|
|
234
254
|
|
|
235
255
|
ARGUMENTS
|
|
236
|
-
OWNER/API_NAME/VERSION API
|
|
256
|
+
OWNER/API_NAME/VERSION API to publish on Swaggerhub
|
|
237
257
|
|
|
238
|
-
|
|
258
|
+
FLAGS
|
|
239
259
|
-f, --force publish API without prompting for confirmation
|
|
240
|
-
-h, --help
|
|
260
|
+
-h, --help Show CLI help.
|
|
261
|
+
|
|
262
|
+
DESCRIPTION
|
|
263
|
+
publish an API version
|
|
241
264
|
|
|
242
265
|
EXAMPLES
|
|
243
|
-
swaggerhub api:publish organization/api/1.0.0
|
|
244
|
-
|
|
266
|
+
$ swaggerhub api:publish organization/api/1.0.0
|
|
267
|
+
|
|
268
|
+
$ swaggerhub api:publish organization/api/1.0.0 --force
|
|
245
269
|
```
|
|
246
270
|
|
|
247
|
-
_See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
271
|
+
_See code: [src/commands/api/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/api/publish.js)_
|
|
248
272
|
|
|
249
273
|
## `swaggerhub api:setdefault`
|
|
250
274
|
|
|
@@ -252,19 +276,22 @@ set the default version of an API
|
|
|
252
276
|
|
|
253
277
|
```
|
|
254
278
|
USAGE
|
|
255
|
-
$ swaggerhub api:setdefault OWNER/API_NAME/VERSION
|
|
279
|
+
$ swaggerhub api:setdefault OWNER/API_NAME/VERSION [-h]
|
|
256
280
|
|
|
257
281
|
ARGUMENTS
|
|
258
|
-
OWNER/API_NAME/VERSION API
|
|
282
|
+
OWNER/API_NAME/VERSION API to set as default on Swaggerhub
|
|
259
283
|
|
|
260
|
-
|
|
261
|
-
-h, --help
|
|
284
|
+
FLAGS
|
|
285
|
+
-h, --help Show CLI help.
|
|
262
286
|
|
|
263
|
-
|
|
264
|
-
|
|
287
|
+
DESCRIPTION
|
|
288
|
+
set the default version of an API
|
|
289
|
+
|
|
290
|
+
EXAMPLES
|
|
291
|
+
$ swaggerhub api:setdefault organization/api/2.0.0
|
|
265
292
|
```
|
|
266
293
|
|
|
267
|
-
_See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
294
|
+
_See code: [src/commands/api/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/api/setdefault.js)_
|
|
268
295
|
|
|
269
296
|
## `swaggerhub api:unpublish`
|
|
270
297
|
|
|
@@ -272,19 +299,22 @@ unpublish an API version
|
|
|
272
299
|
|
|
273
300
|
```
|
|
274
301
|
USAGE
|
|
275
|
-
$ swaggerhub api:unpublish OWNER/API_NAME/VERSION
|
|
302
|
+
$ swaggerhub api:unpublish OWNER/API_NAME/VERSION [-h]
|
|
276
303
|
|
|
277
304
|
ARGUMENTS
|
|
278
305
|
OWNER/API_NAME/VERSION API identifier
|
|
279
306
|
|
|
280
|
-
|
|
281
|
-
-h, --help
|
|
307
|
+
FLAGS
|
|
308
|
+
-h, --help Show CLI help.
|
|
282
309
|
|
|
283
|
-
|
|
284
|
-
|
|
310
|
+
DESCRIPTION
|
|
311
|
+
unpublish an API version
|
|
312
|
+
|
|
313
|
+
EXAMPLES
|
|
314
|
+
$ swaggerhub api:unpublish organization/api/1.0.0
|
|
285
315
|
```
|
|
286
316
|
|
|
287
|
-
_See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
317
|
+
_See code: [src/commands/api/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/api/unpublish.js)_
|
|
288
318
|
|
|
289
319
|
## `swaggerhub api:update`
|
|
290
320
|
|
|
@@ -292,33 +322,43 @@ update an API
|
|
|
292
322
|
|
|
293
323
|
```
|
|
294
324
|
USAGE
|
|
295
|
-
$ swaggerhub api:update OWNER/API_NAME/[VERSION]
|
|
325
|
+
$ swaggerhub api:update OWNER/API_NAME/[VERSION] [-h] [-f <value>] [--visibility public|private] [--published
|
|
326
|
+
publish|unpublish] [--setdefault]
|
|
296
327
|
|
|
297
328
|
ARGUMENTS
|
|
298
|
-
OWNER/API_NAME/[VERSION] API to update
|
|
329
|
+
OWNER/API_NAME/[VERSION] API to update on SwaggerHub
|
|
299
330
|
|
|
300
|
-
|
|
301
|
-
-f, --file
|
|
302
|
-
-h, --help
|
|
303
|
-
--published
|
|
304
|
-
|
|
305
|
-
--
|
|
331
|
+
FLAGS
|
|
332
|
+
-f, --file=<value> file location of API to update
|
|
333
|
+
-h, --help Show CLI help.
|
|
334
|
+
--published=<option> sets the lifecycle setting of the API version
|
|
335
|
+
<options: publish|unpublish>
|
|
336
|
+
--setdefault sets API version to be the default
|
|
337
|
+
--visibility=<option> visibility of API in SwaggerHub
|
|
338
|
+
<options: public|private>
|
|
306
339
|
|
|
307
340
|
DESCRIPTION
|
|
341
|
+
update an API
|
|
308
342
|
The API version from the file will be used unless the version is specified in the command argument.
|
|
309
343
|
When no file is specified then the default API version will be updated.
|
|
310
344
|
The API visibility can be changed by using visibility flag.
|
|
311
345
|
|
|
346
|
+
|
|
312
347
|
EXAMPLES
|
|
313
|
-
swaggerhub api:update organization/api --file api.yaml
|
|
314
|
-
|
|
315
|
-
swaggerhub api:update organization/api/1.0.0 --
|
|
316
|
-
|
|
317
|
-
swaggerhub api:update organization/api/1.0.0 --published=
|
|
318
|
-
|
|
348
|
+
$ swaggerhub api:update organization/api --file api.yaml
|
|
349
|
+
|
|
350
|
+
$ swaggerhub api:update organization/api/1.0.0 --file api.json
|
|
351
|
+
|
|
352
|
+
$ swaggerhub api:update organization/api/1.0.0 --published=publish --file api.json
|
|
353
|
+
|
|
354
|
+
$ swaggerhub api:update organization/api/1.0.0 --setdefault --file api.json
|
|
355
|
+
|
|
356
|
+
$ swaggerhub api:update organization/api/1.0.0 --published=unpublish --setdefault --file api.json
|
|
357
|
+
|
|
358
|
+
$ swaggerhub api:update organization/api/1.0.0 --visibility=private
|
|
319
359
|
```
|
|
320
360
|
|
|
321
|
-
_See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
361
|
+
_See code: [src/commands/api/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/api/update.js)_
|
|
322
362
|
|
|
323
363
|
## `swaggerhub api:validate`
|
|
324
364
|
|
|
@@ -326,24 +366,32 @@ get validation result for an API version
|
|
|
326
366
|
|
|
327
367
|
```
|
|
328
368
|
USAGE
|
|
329
|
-
$ swaggerhub api:validate OWNER/API_NAME/[VERSION]
|
|
369
|
+
$ swaggerhub api:validate OWNER/API_NAME/[VERSION] [-h] [-c]
|
|
330
370
|
|
|
331
371
|
ARGUMENTS
|
|
332
|
-
OWNER/API_NAME/[VERSION] API
|
|
372
|
+
OWNER/API_NAME/[VERSION] API to fetch validation errors for from Swaggerhub
|
|
333
373
|
|
|
334
|
-
|
|
335
|
-
-
|
|
374
|
+
FLAGS
|
|
375
|
+
-c, --fail-on-critical Exit with error code 1 if there are critical standardization errors present
|
|
376
|
+
-h, --help Show CLI help.
|
|
336
377
|
|
|
337
378
|
DESCRIPTION
|
|
379
|
+
get validation result for an API version
|
|
338
380
|
When VERSION is not included in the argument, the default version will be validated.
|
|
339
381
|
An error will occur if the API version does not exist.
|
|
382
|
+
If the flag `-c` or `--failOnCritical` is used and there are standardization
|
|
383
|
+
errors with `Critical` severity present, the command will exit with error code `1`.
|
|
384
|
+
|
|
340
385
|
|
|
341
386
|
EXAMPLES
|
|
342
|
-
swaggerhub api:validate organization/api/1.0.0
|
|
343
|
-
|
|
387
|
+
$ swaggerhub api:validate organization/api/1.0.0
|
|
388
|
+
|
|
389
|
+
$ swaggerhub api:validate -c organization/api/1.0.0
|
|
390
|
+
|
|
391
|
+
$ swaggerhub api:validate --fail-on-critical organization/api
|
|
344
392
|
```
|
|
345
393
|
|
|
346
|
-
_See code: [src/commands/api/validate.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
394
|
+
_See code: [src/commands/api/validate.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/api/validate.js)_
|
|
347
395
|
|
|
348
396
|
## `swaggerhub configure`
|
|
349
397
|
|
|
@@ -351,21 +399,22 @@ configure application settings
|
|
|
351
399
|
|
|
352
400
|
```
|
|
353
401
|
USAGE
|
|
354
|
-
$ swaggerhub configure
|
|
402
|
+
$ swaggerhub configure [-h]
|
|
355
403
|
|
|
356
|
-
|
|
357
|
-
-h, --help
|
|
404
|
+
FLAGS
|
|
405
|
+
-h, --help Show CLI help.
|
|
358
406
|
|
|
359
407
|
DESCRIPTION
|
|
408
|
+
configure application settings
|
|
360
409
|
Enter the SwaggerHub URL - default is https://api.swaggerhub.com
|
|
361
|
-
Customers with on-premise installations need to point this to their on-premise API, which is
|
|
410
|
+
Customers with on-premise installations need to point this to their on-premise API, which is
|
|
362
411
|
http(s)://{swaggerhub-host}/v1
|
|
363
412
|
Enter the API Key - this can be retrieved from https://app.swaggerhub.com/settings/apiKey
|
|
364
|
-
You can set these as environment variables: SWAGGERHUB_URL, SWAGGERHUB_API_KEY. These take priority over config
|
|
413
|
+
You can set these as environment variables: SWAGGERHUB_URL, SWAGGERHUB_API_KEY. These take priority over config
|
|
365
414
|
settings.
|
|
366
415
|
```
|
|
367
416
|
|
|
368
|
-
_See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
417
|
+
_See code: [src/commands/configure.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/configure.js)_
|
|
369
418
|
|
|
370
419
|
## `swaggerhub domain:create`
|
|
371
420
|
|
|
@@ -373,31 +422,40 @@ creates a new domain / domain version from a YAML/JSON file
|
|
|
373
422
|
|
|
374
423
|
```
|
|
375
424
|
USAGE
|
|
376
|
-
$ swaggerhub domain:create OWNER/DOMAIN_NAME/[VERSION]
|
|
425
|
+
$ swaggerhub domain:create OWNER/DOMAIN_NAME/[VERSION] [-h] [--visibility public|private] (--published
|
|
426
|
+
publish|unpublish -f <value>) [--setdefault ]
|
|
377
427
|
|
|
378
428
|
ARGUMENTS
|
|
379
|
-
OWNER/DOMAIN_NAME/[VERSION] Domain to create
|
|
429
|
+
OWNER/DOMAIN_NAME/[VERSION] Domain to create on SwaggerHub
|
|
380
430
|
|
|
381
|
-
|
|
382
|
-
-f, --file
|
|
383
|
-
-h, --help
|
|
384
|
-
--published
|
|
385
|
-
|
|
386
|
-
--
|
|
431
|
+
FLAGS
|
|
432
|
+
-f, --file=<value> (required) file location of domain to create
|
|
433
|
+
-h, --help Show CLI help.
|
|
434
|
+
--published=<option> [default: unpublish] sets the lifecycle setting of the domain version
|
|
435
|
+
<options: publish|unpublish>
|
|
436
|
+
--setdefault sets domain version to be the default
|
|
437
|
+
--visibility=<option> [default: private] visibility of domain in SwaggerHub
|
|
438
|
+
<options: public|private>
|
|
387
439
|
|
|
388
440
|
DESCRIPTION
|
|
441
|
+
creates a new domain / domain version from a YAML/JSON file
|
|
389
442
|
The domain version from the file will be used unless the version is specified in the command argument.
|
|
390
443
|
An error will occur if the domain version already exists.
|
|
391
444
|
|
|
445
|
+
|
|
392
446
|
EXAMPLES
|
|
393
|
-
swaggerhub domain:create organization/domain/1.0.0 --file domain.yaml --visibility public
|
|
394
|
-
|
|
395
|
-
swaggerhub domain:create organization/domain
|
|
396
|
-
|
|
397
|
-
swaggerhub domain:create organization/domain/1.0.0 --publish --
|
|
447
|
+
$ swaggerhub domain:create organization/domain/1.0.0 --file domain.yaml --visibility public
|
|
448
|
+
|
|
449
|
+
$ swaggerhub domain:create organization/domain --file domain.yaml
|
|
450
|
+
|
|
451
|
+
$ swaggerhub domain:create organization/domain/1.0.0 --publish --file domain.json
|
|
452
|
+
|
|
453
|
+
$ swaggerhub domain:create organization/domain/1.0.0 --setdefault --file domain.json
|
|
454
|
+
|
|
455
|
+
$ swaggerhub domain:create organization/domain/1.0.0 --publish --setdefault --file domain.json
|
|
398
456
|
```
|
|
399
457
|
|
|
400
|
-
_See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
458
|
+
_See code: [src/commands/domain/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/domain/create.js)_
|
|
401
459
|
|
|
402
460
|
## `swaggerhub domain:delete`
|
|
403
461
|
|
|
@@ -405,22 +463,28 @@ delete a domain or domain version
|
|
|
405
463
|
|
|
406
464
|
```
|
|
407
465
|
USAGE
|
|
408
|
-
$ swaggerhub domain:delete OWNER/DOMAIN_NAME/[VERSION]
|
|
466
|
+
$ swaggerhub domain:delete OWNER/DOMAIN_NAME/[VERSION] [-h] [-f]
|
|
409
467
|
|
|
410
468
|
ARGUMENTS
|
|
411
|
-
OWNER/DOMAIN_NAME/[VERSION] Domain to delete
|
|
469
|
+
OWNER/DOMAIN_NAME/[VERSION] Domain to delete on SwaggerHub
|
|
412
470
|
|
|
413
|
-
|
|
471
|
+
FLAGS
|
|
414
472
|
-f, --force delete domain without prompting for confirmation
|
|
415
|
-
-h, --help
|
|
473
|
+
-h, --help Show CLI help.
|
|
474
|
+
|
|
475
|
+
DESCRIPTION
|
|
476
|
+
delete a domain or domain version
|
|
477
|
+
|
|
416
478
|
|
|
417
479
|
EXAMPLES
|
|
418
|
-
swaggerhub domain:delete organization/domain/1.0.0
|
|
419
|
-
|
|
420
|
-
swaggerhub domain:delete organization/domain
|
|
480
|
+
$ swaggerhub domain:delete organization/domain/1.0.0
|
|
481
|
+
|
|
482
|
+
$ swaggerhub domain:delete organization/domain
|
|
483
|
+
|
|
484
|
+
$ swaggerhub domain:delete organization/domain --force
|
|
421
485
|
```
|
|
422
486
|
|
|
423
|
-
_See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
487
|
+
_See code: [src/commands/domain/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/domain/delete.js)_
|
|
424
488
|
|
|
425
489
|
## `swaggerhub domain:get`
|
|
426
490
|
|
|
@@ -428,25 +492,28 @@ fetches a domain definition
|
|
|
428
492
|
|
|
429
493
|
```
|
|
430
494
|
USAGE
|
|
431
|
-
$ swaggerhub domain:get OWNER/DOMAIN_NAME/[VERSION]
|
|
495
|
+
$ swaggerhub domain:get OWNER/DOMAIN_NAME/[VERSION] [-h] [-j]
|
|
432
496
|
|
|
433
497
|
ARGUMENTS
|
|
434
|
-
OWNER/DOMAIN_NAME/[VERSION]
|
|
498
|
+
OWNER/DOMAIN_NAME/[VERSION] Domain to fetch from SwaggerHub
|
|
435
499
|
|
|
436
|
-
|
|
437
|
-
-h, --help
|
|
500
|
+
FLAGS
|
|
501
|
+
-h, --help Show CLI help.
|
|
438
502
|
-j, --json returns the domain in JSON format.
|
|
439
503
|
|
|
440
504
|
DESCRIPTION
|
|
505
|
+
fetches a domain definition
|
|
441
506
|
When VERSION is not included in the argument, the default version will be returned.
|
|
442
507
|
Returns the domain in YAML format by default.
|
|
443
508
|
|
|
509
|
+
|
|
444
510
|
EXAMPLES
|
|
445
|
-
swaggerhub domain:get organization/domain
|
|
446
|
-
|
|
511
|
+
$ swaggerhub domain:get organization/domain
|
|
512
|
+
|
|
513
|
+
$ swaggerhub domain:get organization/domain/1.0.0 --json
|
|
447
514
|
```
|
|
448
515
|
|
|
449
|
-
_See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
516
|
+
_See code: [src/commands/domain/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/domain/get.js)_
|
|
450
517
|
|
|
451
518
|
## `swaggerhub domain:publish`
|
|
452
519
|
|
|
@@ -454,19 +521,22 @@ publish a domain version
|
|
|
454
521
|
|
|
455
522
|
```
|
|
456
523
|
USAGE
|
|
457
|
-
$ swaggerhub domain:publish OWNER/DOMAIN_NAME/VERSION
|
|
524
|
+
$ swaggerhub domain:publish OWNER/DOMAIN_NAME/VERSION [-h]
|
|
458
525
|
|
|
459
526
|
ARGUMENTS
|
|
460
|
-
OWNER/DOMAIN_NAME/VERSION Domain
|
|
527
|
+
OWNER/DOMAIN_NAME/VERSION Domain to publish on SwaggerHub
|
|
528
|
+
|
|
529
|
+
FLAGS
|
|
530
|
+
-h, --help Show CLI help.
|
|
461
531
|
|
|
462
|
-
|
|
463
|
-
|
|
532
|
+
DESCRIPTION
|
|
533
|
+
publish a domain version
|
|
464
534
|
|
|
465
|
-
|
|
466
|
-
swaggerhub domain:publish organization/domain/1.0.0
|
|
535
|
+
EXAMPLES
|
|
536
|
+
$ swaggerhub domain:publish organization/domain/1.0.0
|
|
467
537
|
```
|
|
468
538
|
|
|
469
|
-
_See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
539
|
+
_See code: [src/commands/domain/publish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/domain/publish.js)_
|
|
470
540
|
|
|
471
541
|
## `swaggerhub domain:setdefault`
|
|
472
542
|
|
|
@@ -474,19 +544,22 @@ set the default version of a domain
|
|
|
474
544
|
|
|
475
545
|
```
|
|
476
546
|
USAGE
|
|
477
|
-
$ swaggerhub domain:setdefault OWNER/DOMAIN_NAME/VERSION
|
|
547
|
+
$ swaggerhub domain:setdefault OWNER/DOMAIN_NAME/VERSION [-h]
|
|
478
548
|
|
|
479
549
|
ARGUMENTS
|
|
480
|
-
OWNER/DOMAIN_NAME/VERSION
|
|
550
|
+
OWNER/DOMAIN_NAME/VERSION Domain to set as default on SwaggerHub
|
|
551
|
+
|
|
552
|
+
FLAGS
|
|
553
|
+
-h, --help Show CLI help.
|
|
481
554
|
|
|
482
|
-
|
|
483
|
-
|
|
555
|
+
DESCRIPTION
|
|
556
|
+
set the default version of a domain
|
|
484
557
|
|
|
485
|
-
|
|
486
|
-
swaggerhub domain:setdefault organization/domain/2.0.0
|
|
558
|
+
EXAMPLES
|
|
559
|
+
$ swaggerhub domain:setdefault organization/domain/2.0.0
|
|
487
560
|
```
|
|
488
561
|
|
|
489
|
-
_See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
562
|
+
_See code: [src/commands/domain/setdefault.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/domain/setdefault.js)_
|
|
490
563
|
|
|
491
564
|
## `swaggerhub domain:unpublish`
|
|
492
565
|
|
|
@@ -494,19 +567,22 @@ unpublish a domain version
|
|
|
494
567
|
|
|
495
568
|
```
|
|
496
569
|
USAGE
|
|
497
|
-
$ swaggerhub domain:unpublish OWNER/DOMAIN_NAME/VERSION
|
|
570
|
+
$ swaggerhub domain:unpublish OWNER/DOMAIN_NAME/VERSION [-h]
|
|
498
571
|
|
|
499
572
|
ARGUMENTS
|
|
500
|
-
OWNER/DOMAIN_NAME/VERSION Domain
|
|
573
|
+
OWNER/DOMAIN_NAME/VERSION Domain to unpublish on SwaggerHub
|
|
574
|
+
|
|
575
|
+
FLAGS
|
|
576
|
+
-h, --help Show CLI help.
|
|
501
577
|
|
|
502
|
-
|
|
503
|
-
|
|
578
|
+
DESCRIPTION
|
|
579
|
+
unpublish a domain version
|
|
504
580
|
|
|
505
|
-
|
|
506
|
-
swaggerhub domain:unpublish organization/domain/1.0.0
|
|
581
|
+
EXAMPLES
|
|
582
|
+
$ swaggerhub domain:unpublish organization/domain/1.0.0
|
|
507
583
|
```
|
|
508
584
|
|
|
509
|
-
_See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
585
|
+
_See code: [src/commands/domain/unpublish.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/domain/unpublish.js)_
|
|
510
586
|
|
|
511
587
|
## `swaggerhub domain:update`
|
|
512
588
|
|
|
@@ -514,50 +590,63 @@ update a domain
|
|
|
514
590
|
|
|
515
591
|
```
|
|
516
592
|
USAGE
|
|
517
|
-
$ swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION]
|
|
593
|
+
$ swaggerhub domain:update OWNER/DOMAIN_NAME/[VERSION] [-h] [-f <value>] [--visibility public|private]
|
|
594
|
+
[--published publish|unpublish] [--setdefault]
|
|
518
595
|
|
|
519
596
|
ARGUMENTS
|
|
520
|
-
OWNER/DOMAIN_NAME/[VERSION]
|
|
597
|
+
OWNER/DOMAIN_NAME/[VERSION] Domain to update on SwaggerHub
|
|
521
598
|
|
|
522
|
-
|
|
523
|
-
-f, --file
|
|
524
|
-
-h, --help
|
|
525
|
-
--published
|
|
526
|
-
|
|
527
|
-
--
|
|
599
|
+
FLAGS
|
|
600
|
+
-f, --file=<value> file location of domain to update
|
|
601
|
+
-h, --help Show CLI help.
|
|
602
|
+
--published=<option> sets the lifecycle setting of the domain version
|
|
603
|
+
<options: publish|unpublish>
|
|
604
|
+
--setdefault sets domain version to be the default
|
|
605
|
+
--visibility=<option> visibility of domain in SwaggerHub
|
|
606
|
+
<options: public|private>
|
|
528
607
|
|
|
529
608
|
DESCRIPTION
|
|
609
|
+
update a domain
|
|
530
610
|
The domain version from the file will be used unless the version is specified in the command argument.
|
|
531
611
|
When no file is specified then the default domain version will be updated.
|
|
532
612
|
The domain visibility can be changed by using visibility flag.
|
|
533
613
|
|
|
614
|
+
|
|
534
615
|
EXAMPLES
|
|
535
|
-
swaggerhub domain:update organization/domain --file domain.yaml
|
|
536
|
-
|
|
537
|
-
swaggerhub domain:update organization/domain/1.0.0 --
|
|
538
|
-
|
|
539
|
-
swaggerhub domain:update organization/domain/1.0.0 --published=
|
|
540
|
-
|
|
616
|
+
$ swaggerhub domain:update organization/domain --file domain.yaml
|
|
617
|
+
|
|
618
|
+
$ swaggerhub domain:update organization/domain/1.0.0 --file domain.json
|
|
619
|
+
|
|
620
|
+
$ swaggerhub domain:update organization/domain/1.0.0 --published=publish --file domain.json
|
|
621
|
+
|
|
622
|
+
$ swaggerhub domain:update organization/domain/1.0.0 --setdefault --file domain.json
|
|
623
|
+
|
|
624
|
+
$ swaggerhub domain:update organization/domain/1.0.0 --published=unpublish --setdefault --file domain.json
|
|
625
|
+
|
|
626
|
+
$ swaggerhub domain:update organization/domain/1.0.0 --visibility=private
|
|
541
627
|
```
|
|
542
628
|
|
|
543
|
-
_See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
629
|
+
_See code: [src/commands/domain/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/domain/update.js)_
|
|
544
630
|
|
|
545
631
|
## `swaggerhub help`
|
|
546
632
|
|
|
547
|
-
|
|
633
|
+
Display help for swaggerhub.
|
|
548
634
|
|
|
549
635
|
```
|
|
550
636
|
USAGE
|
|
551
|
-
$ swaggerhub help [
|
|
637
|
+
$ swaggerhub help [COMMANDS] [-n]
|
|
552
638
|
|
|
553
639
|
ARGUMENTS
|
|
554
|
-
|
|
640
|
+
COMMANDS Command to show help for.
|
|
555
641
|
|
|
556
|
-
|
|
557
|
-
--
|
|
642
|
+
FLAGS
|
|
643
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
644
|
+
|
|
645
|
+
DESCRIPTION
|
|
646
|
+
Display help for swaggerhub.
|
|
558
647
|
```
|
|
559
648
|
|
|
560
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/
|
|
649
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.8/src/commands/help.ts)_
|
|
561
650
|
|
|
562
651
|
## `swaggerhub integration:create`
|
|
563
652
|
|
|
@@ -565,25 +654,27 @@ creates a new API integration from a JSON configuration file.
|
|
|
565
654
|
|
|
566
655
|
```
|
|
567
656
|
USAGE
|
|
568
|
-
$ swaggerhub integration:create OWNER/API_NAME/[VERSION]
|
|
657
|
+
$ swaggerhub integration:create OWNER/API_NAME/[VERSION] -f <value> [-h]
|
|
569
658
|
|
|
570
659
|
ARGUMENTS
|
|
571
|
-
OWNER/API_NAME/[VERSION] API
|
|
660
|
+
OWNER/API_NAME/[VERSION] API to add integration to on SwaggerHub
|
|
572
661
|
|
|
573
|
-
|
|
574
|
-
-f, --file
|
|
575
|
-
-h, --help
|
|
662
|
+
FLAGS
|
|
663
|
+
-f, --file=<value> (required) location of integration configuration file
|
|
664
|
+
-h, --help Show CLI help.
|
|
576
665
|
|
|
577
666
|
DESCRIPTION
|
|
578
|
-
|
|
579
|
-
|
|
667
|
+
creates a new API integration from a JSON configuration file.
|
|
668
|
+
See the documentation for configuration files:
|
|
669
|
+
https://github.com/SmartBear/swaggerhub-cli/tree/main/examples/integrations
|
|
580
670
|
When VERSION is not included in the argument, the integration will be added to be default API version.
|
|
581
671
|
|
|
582
|
-
|
|
583
|
-
|
|
672
|
+
|
|
673
|
+
EXAMPLES
|
|
674
|
+
$ swaggerhub integration:create organization/api/1.0.0 --file config.json
|
|
584
675
|
```
|
|
585
676
|
|
|
586
|
-
_See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
677
|
+
_See code: [src/commands/integration/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/integration/create.js)_
|
|
587
678
|
|
|
588
679
|
## `swaggerhub integration:delete`
|
|
589
680
|
|
|
@@ -591,19 +682,22 @@ deletes the integration from the given API.
|
|
|
591
682
|
|
|
592
683
|
```
|
|
593
684
|
USAGE
|
|
594
|
-
$ swaggerhub integration:delete OWNER/API_NAME/VERSION/INTEGRATION_ID
|
|
685
|
+
$ swaggerhub integration:delete OWNER/API_NAME/VERSION/INTEGRATION_ID [-h]
|
|
595
686
|
|
|
596
687
|
ARGUMENTS
|
|
597
|
-
OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to delete
|
|
688
|
+
OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to delete for given API on Swaggerhub
|
|
689
|
+
|
|
690
|
+
FLAGS
|
|
691
|
+
-h, --help Show CLI help.
|
|
598
692
|
|
|
599
|
-
|
|
600
|
-
|
|
693
|
+
DESCRIPTION
|
|
694
|
+
deletes the integration from the given API.
|
|
601
695
|
|
|
602
|
-
|
|
603
|
-
swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
696
|
+
EXAMPLES
|
|
697
|
+
$ swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
604
698
|
```
|
|
605
699
|
|
|
606
|
-
_See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
700
|
+
_See code: [src/commands/integration/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/integration/delete.js)_
|
|
607
701
|
|
|
608
702
|
## `swaggerhub integration:execute`
|
|
609
703
|
|
|
@@ -611,19 +705,22 @@ executes an integration for the given API.
|
|
|
611
705
|
|
|
612
706
|
```
|
|
613
707
|
USAGE
|
|
614
|
-
$ swaggerhub integration:execute OWNER/API_NAME/VERSION/INTEGRATION_ID
|
|
708
|
+
$ swaggerhub integration:execute OWNER/API_NAME/VERSION/INTEGRATION_ID [-h]
|
|
615
709
|
|
|
616
710
|
ARGUMENTS
|
|
617
|
-
OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to execute for given API
|
|
711
|
+
OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to execute for given API on Swaggerhub
|
|
618
712
|
|
|
619
|
-
|
|
620
|
-
-h, --help
|
|
713
|
+
FLAGS
|
|
714
|
+
-h, --help Show CLI help.
|
|
621
715
|
|
|
622
|
-
|
|
623
|
-
|
|
716
|
+
DESCRIPTION
|
|
717
|
+
executes an integration for the given API.
|
|
718
|
+
|
|
719
|
+
EXAMPLES
|
|
720
|
+
$ swaggerhub integration:execute organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
624
721
|
```
|
|
625
722
|
|
|
626
|
-
_See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
723
|
+
_See code: [src/commands/integration/execute.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/integration/execute.js)_
|
|
627
724
|
|
|
628
725
|
## `swaggerhub integration:get`
|
|
629
726
|
|
|
@@ -631,19 +728,22 @@ retieves an integration for the given API.
|
|
|
631
728
|
|
|
632
729
|
```
|
|
633
730
|
USAGE
|
|
634
|
-
$ swaggerhub integration:get OWNER/API_NAME/VERSION/INTEGRATION_ID
|
|
731
|
+
$ swaggerhub integration:get OWNER/API_NAME/VERSION/INTEGRATION_ID [-h]
|
|
635
732
|
|
|
636
733
|
ARGUMENTS
|
|
637
|
-
OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to fetch for given API
|
|
734
|
+
OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to fetch for given API on Swaggerhub
|
|
638
735
|
|
|
639
|
-
|
|
640
|
-
-h, --help
|
|
736
|
+
FLAGS
|
|
737
|
+
-h, --help Show CLI help.
|
|
641
738
|
|
|
642
|
-
|
|
643
|
-
|
|
739
|
+
DESCRIPTION
|
|
740
|
+
retieves an integration for the given API.
|
|
741
|
+
|
|
742
|
+
EXAMPLES
|
|
743
|
+
$ swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704
|
|
644
744
|
```
|
|
645
745
|
|
|
646
|
-
_See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
746
|
+
_See code: [src/commands/integration/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/integration/get.js)_
|
|
647
747
|
|
|
648
748
|
## `swaggerhub integration:list`
|
|
649
749
|
|
|
@@ -651,19 +751,22 @@ list integrations on an API.
|
|
|
651
751
|
|
|
652
752
|
```
|
|
653
753
|
USAGE
|
|
654
|
-
$ swaggerhub integration:list OWNER/API_NAME/[VERSION]
|
|
754
|
+
$ swaggerhub integration:list OWNER/API_NAME/[VERSION] [-h]
|
|
655
755
|
|
|
656
756
|
ARGUMENTS
|
|
657
|
-
OWNER/API_NAME/[VERSION] API to list integrations on
|
|
757
|
+
OWNER/API_NAME/[VERSION] API to list integrations for on Swaggerhub
|
|
658
758
|
|
|
659
|
-
|
|
660
|
-
-h, --help
|
|
759
|
+
FLAGS
|
|
760
|
+
-h, --help Show CLI help.
|
|
661
761
|
|
|
662
|
-
|
|
663
|
-
|
|
762
|
+
DESCRIPTION
|
|
763
|
+
list integrations on an API.
|
|
764
|
+
|
|
765
|
+
EXAMPLES
|
|
766
|
+
$ swaggerhub integration:list organization/api/1.0.0
|
|
664
767
|
```
|
|
665
768
|
|
|
666
|
-
_See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
769
|
+
_See code: [src/commands/integration/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/integration/list.js)_
|
|
667
770
|
|
|
668
771
|
## `swaggerhub integration:update`
|
|
669
772
|
|
|
@@ -671,20 +774,23 @@ update the configuration of an API integration.
|
|
|
671
774
|
|
|
672
775
|
```
|
|
673
776
|
USAGE
|
|
674
|
-
$ swaggerhub integration:update OWNER/API_NAME/VERSION/INTEGRATION_ID
|
|
777
|
+
$ swaggerhub integration:update OWNER/API_NAME/VERSION/INTEGRATION_ID -f <value> [-h]
|
|
675
778
|
|
|
676
779
|
ARGUMENTS
|
|
677
|
-
OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to update
|
|
780
|
+
OWNER/API_NAME/VERSION/INTEGRATION_ID Integration to update for given API on Swaggerhub
|
|
678
781
|
|
|
679
|
-
|
|
680
|
-
-f, --file
|
|
681
|
-
-h, --help
|
|
782
|
+
FLAGS
|
|
783
|
+
-f, --file=<value> (required) location of integration configuration file
|
|
784
|
+
-h, --help Show CLI help.
|
|
682
785
|
|
|
683
|
-
|
|
684
|
-
|
|
786
|
+
DESCRIPTION
|
|
787
|
+
update the configuration of an API integration.
|
|
788
|
+
|
|
789
|
+
EXAMPLES
|
|
790
|
+
$ swaggerhub integration:update organization/api/1.0.0/503c2db6-448a-4678-abcd-0123456789abc --file config.json
|
|
685
791
|
```
|
|
686
792
|
|
|
687
|
-
_See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
793
|
+
_See code: [src/commands/integration/update.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/integration/update.js)_
|
|
688
794
|
|
|
689
795
|
## `swaggerhub plugins`
|
|
690
796
|
|
|
@@ -692,16 +798,57 @@ List installed plugins.
|
|
|
692
798
|
|
|
693
799
|
```
|
|
694
800
|
USAGE
|
|
695
|
-
$ swaggerhub plugins
|
|
801
|
+
$ swaggerhub plugins [--core]
|
|
696
802
|
|
|
697
|
-
|
|
803
|
+
FLAGS
|
|
698
804
|
--core Show core plugins.
|
|
699
805
|
|
|
700
|
-
|
|
806
|
+
DESCRIPTION
|
|
807
|
+
List installed plugins.
|
|
808
|
+
|
|
809
|
+
EXAMPLES
|
|
701
810
|
$ swaggerhub plugins
|
|
702
811
|
```
|
|
703
812
|
|
|
704
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.
|
|
813
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.3/src/commands/plugins/index.ts)_
|
|
814
|
+
|
|
815
|
+
## `swaggerhub plugins:install`
|
|
816
|
+
|
|
817
|
+
Installs a plugin into the CLI.
|
|
818
|
+
|
|
819
|
+
```
|
|
820
|
+
USAGE
|
|
821
|
+
$ swaggerhub plugins:install PLUGIN...
|
|
822
|
+
|
|
823
|
+
ARGUMENTS
|
|
824
|
+
PLUGIN Plugin to install.
|
|
825
|
+
|
|
826
|
+
FLAGS
|
|
827
|
+
-f, --force Run yarn install with force flag.
|
|
828
|
+
-h, --help Show CLI help.
|
|
829
|
+
-v, --verbose
|
|
830
|
+
|
|
831
|
+
DESCRIPTION
|
|
832
|
+
Installs a plugin into the CLI.
|
|
833
|
+
Can be installed from npm or a git url.
|
|
834
|
+
|
|
835
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
836
|
+
|
|
837
|
+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
|
|
838
|
+
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
|
|
839
|
+
the CLI without the need to patch and update the whole CLI.
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
ALIASES
|
|
843
|
+
$ swaggerhub plugins:add
|
|
844
|
+
|
|
845
|
+
EXAMPLES
|
|
846
|
+
$ swaggerhub plugins:install myplugin
|
|
847
|
+
|
|
848
|
+
$ swaggerhub plugins:install https://github.com/someuser/someplugin
|
|
849
|
+
|
|
850
|
+
$ swaggerhub plugins:install someuser/someplugin
|
|
851
|
+
```
|
|
705
852
|
|
|
706
853
|
## `swaggerhub plugins:inspect`
|
|
707
854
|
|
|
@@ -714,15 +861,21 @@ USAGE
|
|
|
714
861
|
ARGUMENTS
|
|
715
862
|
PLUGIN [default: .] Plugin to inspect.
|
|
716
863
|
|
|
717
|
-
|
|
864
|
+
FLAGS
|
|
718
865
|
-h, --help Show CLI help.
|
|
719
866
|
-v, --verbose
|
|
720
867
|
|
|
721
|
-
|
|
868
|
+
GLOBAL FLAGS
|
|
869
|
+
--json Format output as json.
|
|
870
|
+
|
|
871
|
+
DESCRIPTION
|
|
872
|
+
Displays installation properties of a plugin.
|
|
873
|
+
|
|
874
|
+
EXAMPLES
|
|
722
875
|
$ swaggerhub plugins:inspect myplugin
|
|
723
876
|
```
|
|
724
877
|
|
|
725
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.
|
|
878
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.3/src/commands/plugins/inspect.ts)_
|
|
726
879
|
|
|
727
880
|
## `swaggerhub plugins:install`
|
|
728
881
|
|
|
@@ -735,30 +888,34 @@ USAGE
|
|
|
735
888
|
ARGUMENTS
|
|
736
889
|
PLUGIN Plugin to install.
|
|
737
890
|
|
|
738
|
-
|
|
891
|
+
FLAGS
|
|
739
892
|
-f, --force Run yarn install with force flag.
|
|
740
893
|
-h, --help Show CLI help.
|
|
741
894
|
-v, --verbose
|
|
742
895
|
|
|
743
896
|
DESCRIPTION
|
|
897
|
+
Installs a plugin into the CLI.
|
|
744
898
|
Can be installed from npm or a git url.
|
|
745
899
|
|
|
746
900
|
Installation of a user-installed plugin will override a core plugin.
|
|
747
901
|
|
|
748
|
-
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
|
|
749
|
-
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
|
|
902
|
+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
|
|
903
|
+
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
|
|
750
904
|
the CLI without the need to patch and update the whole CLI.
|
|
751
905
|
|
|
906
|
+
|
|
752
907
|
ALIASES
|
|
753
908
|
$ swaggerhub plugins:add
|
|
754
909
|
|
|
755
910
|
EXAMPLES
|
|
756
911
|
$ swaggerhub plugins:install myplugin
|
|
912
|
+
|
|
757
913
|
$ swaggerhub plugins:install https://github.com/someuser/someplugin
|
|
914
|
+
|
|
758
915
|
$ swaggerhub plugins:install someuser/someplugin
|
|
759
916
|
```
|
|
760
917
|
|
|
761
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.
|
|
918
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.3/src/commands/plugins/install.ts)_
|
|
762
919
|
|
|
763
920
|
## `swaggerhub plugins:link`
|
|
764
921
|
|
|
@@ -771,21 +928,23 @@ USAGE
|
|
|
771
928
|
ARGUMENTS
|
|
772
929
|
PATH [default: .] path to plugin
|
|
773
930
|
|
|
774
|
-
|
|
931
|
+
FLAGS
|
|
775
932
|
-h, --help Show CLI help.
|
|
776
933
|
-v, --verbose
|
|
777
934
|
|
|
778
935
|
DESCRIPTION
|
|
936
|
+
Links a plugin into the CLI for development.
|
|
779
937
|
Installation of a linked plugin will override a user-installed or core plugin.
|
|
780
938
|
|
|
781
939
|
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
|
|
782
|
-
|
|
940
|
+
command will override the user-installed or core plugin implementation. This is useful for development work.
|
|
783
941
|
|
|
784
|
-
|
|
942
|
+
|
|
943
|
+
EXAMPLES
|
|
785
944
|
$ swaggerhub plugins:link myplugin
|
|
786
945
|
```
|
|
787
946
|
|
|
788
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.
|
|
947
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.3/src/commands/plugins/link.ts)_
|
|
789
948
|
|
|
790
949
|
## `swaggerhub plugins:uninstall`
|
|
791
950
|
|
|
@@ -798,16 +957,65 @@ USAGE
|
|
|
798
957
|
ARGUMENTS
|
|
799
958
|
PLUGIN plugin to uninstall
|
|
800
959
|
|
|
801
|
-
|
|
960
|
+
FLAGS
|
|
802
961
|
-h, --help Show CLI help.
|
|
803
962
|
-v, --verbose
|
|
804
963
|
|
|
964
|
+
DESCRIPTION
|
|
965
|
+
Removes a plugin from the CLI.
|
|
966
|
+
|
|
805
967
|
ALIASES
|
|
806
968
|
$ swaggerhub plugins:unlink
|
|
807
969
|
$ swaggerhub plugins:remove
|
|
808
970
|
```
|
|
809
971
|
|
|
810
|
-
|
|
972
|
+
## `swaggerhub plugins:uninstall`
|
|
973
|
+
|
|
974
|
+
Removes a plugin from the CLI.
|
|
975
|
+
|
|
976
|
+
```
|
|
977
|
+
USAGE
|
|
978
|
+
$ swaggerhub plugins:uninstall PLUGIN...
|
|
979
|
+
|
|
980
|
+
ARGUMENTS
|
|
981
|
+
PLUGIN plugin to uninstall
|
|
982
|
+
|
|
983
|
+
FLAGS
|
|
984
|
+
-h, --help Show CLI help.
|
|
985
|
+
-v, --verbose
|
|
986
|
+
|
|
987
|
+
DESCRIPTION
|
|
988
|
+
Removes a plugin from the CLI.
|
|
989
|
+
|
|
990
|
+
ALIASES
|
|
991
|
+
$ swaggerhub plugins:unlink
|
|
992
|
+
$ swaggerhub plugins:remove
|
|
993
|
+
```
|
|
994
|
+
|
|
995
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.3/src/commands/plugins/uninstall.ts)_
|
|
996
|
+
|
|
997
|
+
## `swaggerhub plugins:uninstall`
|
|
998
|
+
|
|
999
|
+
Removes a plugin from the CLI.
|
|
1000
|
+
|
|
1001
|
+
```
|
|
1002
|
+
USAGE
|
|
1003
|
+
$ swaggerhub plugins:uninstall PLUGIN...
|
|
1004
|
+
|
|
1005
|
+
ARGUMENTS
|
|
1006
|
+
PLUGIN plugin to uninstall
|
|
1007
|
+
|
|
1008
|
+
FLAGS
|
|
1009
|
+
-h, --help Show CLI help.
|
|
1010
|
+
-v, --verbose
|
|
1011
|
+
|
|
1012
|
+
DESCRIPTION
|
|
1013
|
+
Removes a plugin from the CLI.
|
|
1014
|
+
|
|
1015
|
+
ALIASES
|
|
1016
|
+
$ swaggerhub plugins:unlink
|
|
1017
|
+
$ swaggerhub plugins:remove
|
|
1018
|
+
```
|
|
811
1019
|
|
|
812
1020
|
## `swaggerhub plugins:update`
|
|
813
1021
|
|
|
@@ -815,14 +1023,17 @@ Update installed plugins.
|
|
|
815
1023
|
|
|
816
1024
|
```
|
|
817
1025
|
USAGE
|
|
818
|
-
$ swaggerhub plugins:update
|
|
1026
|
+
$ swaggerhub plugins:update [-h] [-v]
|
|
819
1027
|
|
|
820
|
-
|
|
1028
|
+
FLAGS
|
|
821
1029
|
-h, --help Show CLI help.
|
|
822
1030
|
-v, --verbose
|
|
1031
|
+
|
|
1032
|
+
DESCRIPTION
|
|
1033
|
+
Update installed plugins.
|
|
823
1034
|
```
|
|
824
1035
|
|
|
825
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.
|
|
1036
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.3/src/commands/plugins/update.ts)_
|
|
826
1037
|
|
|
827
1038
|
## `swaggerhub project:api:add`
|
|
828
1039
|
|
|
@@ -830,20 +1041,23 @@ Adds an API to an existing project.
|
|
|
830
1041
|
|
|
831
1042
|
```
|
|
832
1043
|
USAGE
|
|
833
|
-
$ swaggerhub project:api:add OWNER/PROJECT_NAME API
|
|
1044
|
+
$ swaggerhub project:api:add OWNER/PROJECT_NAME API [-h]
|
|
834
1045
|
|
|
835
1046
|
ARGUMENTS
|
|
836
|
-
OWNER/PROJECT_NAME The project to add the API to
|
|
837
|
-
API The name of the API to add
|
|
1047
|
+
OWNER/PROJECT_NAME The project to add the API to on Swaggerhub
|
|
1048
|
+
API The name of the API on Swaggerhub to add
|
|
838
1049
|
|
|
839
|
-
|
|
840
|
-
-h, --help
|
|
1050
|
+
FLAGS
|
|
1051
|
+
-h, --help Show CLI help.
|
|
841
1052
|
|
|
842
|
-
|
|
843
|
-
|
|
1053
|
+
DESCRIPTION
|
|
1054
|
+
Adds an API to an existing project.
|
|
1055
|
+
|
|
1056
|
+
EXAMPLES
|
|
1057
|
+
$ swaggerhub project:api:add organization/project_name my_api
|
|
844
1058
|
```
|
|
845
1059
|
|
|
846
|
-
_See code: [src/commands/project/api/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1060
|
+
_See code: [src/commands/project/api/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/project/api/add.js)_
|
|
847
1061
|
|
|
848
1062
|
## `swaggerhub project:api:remove`
|
|
849
1063
|
|
|
@@ -851,20 +1065,23 @@ Removes an API from a project in SwaggerHub.
|
|
|
851
1065
|
|
|
852
1066
|
```
|
|
853
1067
|
USAGE
|
|
854
|
-
$ swaggerhub project:api:remove OWNER/PROJECT_NAME API
|
|
1068
|
+
$ swaggerhub project:api:remove OWNER/PROJECT_NAME API [-h]
|
|
855
1069
|
|
|
856
1070
|
ARGUMENTS
|
|
857
|
-
OWNER/PROJECT_NAME The project remove the API from
|
|
858
|
-
API The API to remove
|
|
1071
|
+
OWNER/PROJECT_NAME The project to remove the API from on Swaggerhub
|
|
1072
|
+
API The name of the API on Swaggerhub to remove
|
|
859
1073
|
|
|
860
|
-
|
|
861
|
-
-h, --help
|
|
1074
|
+
FLAGS
|
|
1075
|
+
-h, --help Show CLI help.
|
|
862
1076
|
|
|
863
|
-
|
|
864
|
-
|
|
1077
|
+
DESCRIPTION
|
|
1078
|
+
Removes an API from a project in SwaggerHub.
|
|
1079
|
+
|
|
1080
|
+
EXAMPLES
|
|
1081
|
+
$ swaggerhub project:api:remove organization/project_name my_api
|
|
865
1082
|
```
|
|
866
1083
|
|
|
867
|
-
_See code: [src/commands/project/api/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1084
|
+
_See code: [src/commands/project/api/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/project/api/remove.js)_
|
|
868
1085
|
|
|
869
1086
|
## `swaggerhub project:create`
|
|
870
1087
|
|
|
@@ -872,27 +1089,35 @@ Creates a new project in SwaggerHub.
|
|
|
872
1089
|
|
|
873
1090
|
```
|
|
874
1091
|
USAGE
|
|
875
|
-
$ swaggerhub project:create OWNER/PROJECT_NAME
|
|
1092
|
+
$ swaggerhub project:create OWNER/PROJECT_NAME [-h] [--description <value>] [-a <value>] [-d <value>]
|
|
876
1093
|
|
|
877
1094
|
ARGUMENTS
|
|
878
|
-
OWNER/PROJECT_NAME The new project to create
|
|
1095
|
+
OWNER/PROJECT_NAME The new project to create on Swaggerhub
|
|
879
1096
|
|
|
880
|
-
|
|
881
|
-
-a, --apis
|
|
882
|
-
-d, --domains
|
|
883
|
-
-h, --help
|
|
884
|
-
--description
|
|
1097
|
+
FLAGS
|
|
1098
|
+
-a, --apis=<value> Comma separated list of api names to include in project
|
|
1099
|
+
-d, --domains=<value> Comma separated list of domain names to include in project
|
|
1100
|
+
-h, --help Show CLI help.
|
|
1101
|
+
--description=<value> Description of project
|
|
1102
|
+
|
|
1103
|
+
DESCRIPTION
|
|
1104
|
+
Creates a new project in SwaggerHub.
|
|
885
1105
|
|
|
886
1106
|
EXAMPLES
|
|
887
|
-
swaggerhub project:create organization/new_project_name --description "project description"
|
|
888
|
-
|
|
889
|
-
swaggerhub project:create organization/new_project_name
|
|
890
|
-
|
|
891
|
-
swaggerhub project:create organization/new_project_name --
|
|
892
|
-
|
|
1107
|
+
$ swaggerhub project:create organization/new_project_name --description "project description"
|
|
1108
|
+
|
|
1109
|
+
$ swaggerhub project:create organization/new_project_name -a "testapi1,testapi2"
|
|
1110
|
+
|
|
1111
|
+
$ swaggerhub project:create organization/new_project_name --apis "testapi1,testapi2"
|
|
1112
|
+
|
|
1113
|
+
$ swaggerhub project:create organization/new_project_name -d "testdomain3,testdomain4"
|
|
1114
|
+
|
|
1115
|
+
$ swaggerhub project:create organization/new_project_name --domains "testdomain3,testdomain4"
|
|
1116
|
+
|
|
1117
|
+
$ swaggerhub project:create organization/new_project_name -a "testapi1" -d "testdomain3" --description "description"
|
|
893
1118
|
```
|
|
894
1119
|
|
|
895
|
-
_See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1120
|
+
_See code: [src/commands/project/create.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/project/create.js)_
|
|
896
1121
|
|
|
897
1122
|
## `swaggerhub project:delete`
|
|
898
1123
|
|
|
@@ -900,19 +1125,22 @@ Deletes a project from SwaggerHub.
|
|
|
900
1125
|
|
|
901
1126
|
```
|
|
902
1127
|
USAGE
|
|
903
|
-
$ swaggerhub project:delete OWNER/PROJECT_NAME
|
|
1128
|
+
$ swaggerhub project:delete OWNER/PROJECT_NAME [-h]
|
|
904
1129
|
|
|
905
1130
|
ARGUMENTS
|
|
906
|
-
OWNER/PROJECT_NAME
|
|
1131
|
+
OWNER/PROJECT_NAME The project to delete on Swaggerhub
|
|
907
1132
|
|
|
908
|
-
|
|
909
|
-
-h, --help
|
|
1133
|
+
FLAGS
|
|
1134
|
+
-h, --help Show CLI help.
|
|
910
1135
|
|
|
911
|
-
|
|
912
|
-
|
|
1136
|
+
DESCRIPTION
|
|
1137
|
+
Deletes a project from SwaggerHub.
|
|
1138
|
+
|
|
1139
|
+
EXAMPLES
|
|
1140
|
+
$ swaggerhub project:delete organization/project_name
|
|
913
1141
|
```
|
|
914
1142
|
|
|
915
|
-
_See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1143
|
+
_See code: [src/commands/project/delete.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/project/delete.js)_
|
|
916
1144
|
|
|
917
1145
|
## `swaggerhub project:domain:add`
|
|
918
1146
|
|
|
@@ -920,20 +1148,23 @@ Adds a domain to an existing project.
|
|
|
920
1148
|
|
|
921
1149
|
```
|
|
922
1150
|
USAGE
|
|
923
|
-
$ swaggerhub project:domain:add OWNER/PROJECT_NAME DOMAIN
|
|
1151
|
+
$ swaggerhub project:domain:add OWNER/PROJECT_NAME DOMAIN [-h]
|
|
924
1152
|
|
|
925
1153
|
ARGUMENTS
|
|
926
|
-
OWNER/PROJECT_NAME The project to add the domain to
|
|
927
|
-
DOMAIN The name of the domain to add
|
|
1154
|
+
OWNER/PROJECT_NAME The project to add the domain to on Swaggerhub
|
|
1155
|
+
DOMAIN The name of the domain on Swaggerhub to add
|
|
928
1156
|
|
|
929
|
-
|
|
930
|
-
-h, --help
|
|
1157
|
+
FLAGS
|
|
1158
|
+
-h, --help Show CLI help.
|
|
931
1159
|
|
|
932
|
-
|
|
933
|
-
|
|
1160
|
+
DESCRIPTION
|
|
1161
|
+
Adds a domain to an existing project.
|
|
1162
|
+
|
|
1163
|
+
EXAMPLES
|
|
1164
|
+
$ swaggerhub project:domain:add organization/project_name my_domain
|
|
934
1165
|
```
|
|
935
1166
|
|
|
936
|
-
_See code: [src/commands/project/domain/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1167
|
+
_See code: [src/commands/project/domain/add.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/project/domain/add.js)_
|
|
937
1168
|
|
|
938
1169
|
## `swaggerhub project:domain:remove`
|
|
939
1170
|
|
|
@@ -941,20 +1172,23 @@ Removes a domain from a project in SwaggerHub.
|
|
|
941
1172
|
|
|
942
1173
|
```
|
|
943
1174
|
USAGE
|
|
944
|
-
$ swaggerhub project:domain:remove OWNER/PROJECT_NAME DOMAIN
|
|
1175
|
+
$ swaggerhub project:domain:remove OWNER/PROJECT_NAME DOMAIN [-h]
|
|
945
1176
|
|
|
946
1177
|
ARGUMENTS
|
|
947
|
-
OWNER/PROJECT_NAME The project remove the domain from
|
|
948
|
-
DOMAIN The domain to remove
|
|
1178
|
+
OWNER/PROJECT_NAME The project to remove the domain from on Swaggerhub
|
|
1179
|
+
DOMAIN The name of the domain on Swaggerhub to remove
|
|
949
1180
|
|
|
950
|
-
|
|
951
|
-
-h, --help
|
|
1181
|
+
FLAGS
|
|
1182
|
+
-h, --help Show CLI help.
|
|
952
1183
|
|
|
953
|
-
|
|
954
|
-
|
|
1184
|
+
DESCRIPTION
|
|
1185
|
+
Removes a domain from a project in SwaggerHub.
|
|
1186
|
+
|
|
1187
|
+
EXAMPLES
|
|
1188
|
+
$ swaggerhub project:domain:remove organization/project_name my_domain
|
|
955
1189
|
```
|
|
956
1190
|
|
|
957
|
-
_See code: [src/commands/project/domain/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1191
|
+
_See code: [src/commands/project/domain/remove.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/project/domain/remove.js)_
|
|
958
1192
|
|
|
959
1193
|
## `swaggerhub project:get`
|
|
960
1194
|
|
|
@@ -962,19 +1196,22 @@ Retrieves the details for a project.
|
|
|
962
1196
|
|
|
963
1197
|
```
|
|
964
1198
|
USAGE
|
|
965
|
-
$ swaggerhub project:get OWNER/PROJECT_NAME
|
|
1199
|
+
$ swaggerhub project:get OWNER/PROJECT_NAME [-h]
|
|
966
1200
|
|
|
967
1201
|
ARGUMENTS
|
|
968
|
-
OWNER/PROJECT_NAME
|
|
1202
|
+
OWNER/PROJECT_NAME The project to get details for on Swaggerhub
|
|
969
1203
|
|
|
970
|
-
|
|
971
|
-
-h, --help
|
|
1204
|
+
FLAGS
|
|
1205
|
+
-h, --help Show CLI help.
|
|
972
1206
|
|
|
973
|
-
|
|
974
|
-
|
|
1207
|
+
DESCRIPTION
|
|
1208
|
+
Retrieves the details for a project.
|
|
1209
|
+
|
|
1210
|
+
EXAMPLES
|
|
1211
|
+
$ swaggerhub project:get organization/project_name
|
|
975
1212
|
```
|
|
976
1213
|
|
|
977
|
-
_See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1214
|
+
_See code: [src/commands/project/get.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/project/get.js)_
|
|
978
1215
|
|
|
979
1216
|
## `swaggerhub project:list`
|
|
980
1217
|
|
|
@@ -982,20 +1219,24 @@ list projects
|
|
|
982
1219
|
|
|
983
1220
|
```
|
|
984
1221
|
USAGE
|
|
985
|
-
$ swaggerhub project:list [OWNER]
|
|
1222
|
+
$ swaggerhub project:list [OWNER] [-h]
|
|
986
1223
|
|
|
987
1224
|
ARGUMENTS
|
|
988
|
-
OWNER
|
|
1225
|
+
OWNER The organization to list projects for on Swaggerhub
|
|
989
1226
|
|
|
990
|
-
|
|
991
|
-
-h, --help
|
|
1227
|
+
FLAGS
|
|
1228
|
+
-h, --help Show CLI help.
|
|
1229
|
+
|
|
1230
|
+
DESCRIPTION
|
|
1231
|
+
list projects
|
|
992
1232
|
|
|
993
1233
|
EXAMPLES
|
|
994
|
-
swaggerhub project:list
|
|
995
|
-
|
|
1234
|
+
$ swaggerhub project:list
|
|
1235
|
+
|
|
1236
|
+
$ swaggerhub project:list organization
|
|
996
1237
|
```
|
|
997
1238
|
|
|
998
|
-
_See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1239
|
+
_See code: [src/commands/project/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/project/list.js)_
|
|
999
1240
|
|
|
1000
1241
|
## `swaggerhub project:member:list`
|
|
1001
1242
|
|
|
@@ -1003,19 +1244,22 @@ list members of a project
|
|
|
1003
1244
|
|
|
1004
1245
|
```
|
|
1005
1246
|
USAGE
|
|
1006
|
-
$ swaggerhub project:member:list OWNER/PROJECT_NAME
|
|
1247
|
+
$ swaggerhub project:member:list OWNER/PROJECT_NAME [-h]
|
|
1007
1248
|
|
|
1008
1249
|
ARGUMENTS
|
|
1009
|
-
OWNER/PROJECT_NAME Project to list members of
|
|
1250
|
+
OWNER/PROJECT_NAME Project to list members of on Swaggerhub
|
|
1010
1251
|
|
|
1011
|
-
|
|
1012
|
-
-h, --help
|
|
1252
|
+
FLAGS
|
|
1253
|
+
-h, --help Show CLI help.
|
|
1013
1254
|
|
|
1014
|
-
|
|
1015
|
-
|
|
1255
|
+
DESCRIPTION
|
|
1256
|
+
list members of a project
|
|
1257
|
+
|
|
1258
|
+
EXAMPLES
|
|
1259
|
+
$ swaggerhub project:member:list organisation/project_name
|
|
1016
1260
|
```
|
|
1017
1261
|
|
|
1018
|
-
_See code: [src/commands/project/member/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.
|
|
1262
|
+
_See code: [src/commands/project/member/list.js](https://github.com/SmartBear/swaggerhub-cli/blob/v0.7.1/src/commands/project/member/list.js)_
|
|
1019
1263
|
<!-- commandsstop -->
|
|
1020
1264
|
|
|
1021
1265
|
# Plugins
|