swaggerhub-cli 0.8.1 → 0.9.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 +214 -137
- package/oclif.manifest.json +1017 -626
- package/package.json +15 -14
- package/src/commands/api/validate/download-rules.js +58 -0
- package/src/config/index.js +3 -2
- package/src/requests/standardization.js +14 -1
package/oclif.manifest.json
CHANGED
|
@@ -1,33 +1,43 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.8.1",
|
|
3
2
|
"commands": {
|
|
4
3
|
"configure": {
|
|
5
|
-
"id": "configure",
|
|
6
|
-
"description": "configure application settings\nEnter the SwaggerHub URL - default is https://api.swaggerhub.com\nCustomers with on-premise installations need to point this to their on-premise API, which is http(s)://{swaggerhub-host}/v1\nEnter the API Key - this can be retrieved from https://app.swaggerhub.com/settings/apiKey\nYou can set these as environment variables: SWAGGERHUB_URL, SWAGGERHUB_API_KEY. These take priority over config settings.\n",
|
|
7
|
-
"strict": true,
|
|
8
|
-
"pluginName": "swaggerhub-cli",
|
|
9
|
-
"pluginAlias": "swaggerhub-cli",
|
|
10
|
-
"pluginType": "core",
|
|
11
4
|
"aliases": [],
|
|
5
|
+
"args": {},
|
|
6
|
+
"description": "configure application settings\nEnter the SwaggerHub URL - default is https://api.swaggerhub.com\nCustomers with on-premise installations need to point this to their on-premise API, which is http(s)://{swaggerhub-host}/v1\nEnter the API Key - this can be retrieved from https://app.swaggerhub.com/settings/apiKey\nYou can set these as environment variables: SWAGGERHUB_URL, SWAGGERHUB_API_KEY. These take priority over config settings.\n",
|
|
12
7
|
"flags": {
|
|
13
8
|
"help": {
|
|
14
|
-
"name": "help",
|
|
15
|
-
"type": "boolean",
|
|
16
9
|
"char": "h",
|
|
17
10
|
"description": "Show CLI help.",
|
|
18
|
-
"
|
|
11
|
+
"name": "help",
|
|
12
|
+
"allowNo": false,
|
|
13
|
+
"type": "boolean"
|
|
19
14
|
}
|
|
20
15
|
},
|
|
21
|
-
"
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
"id": "api:create",
|
|
25
|
-
"description": "creates a new API / API version from a YAML/JSON file\nThe API version from the file will be used unless the version is specified in the command argument.\nAn error will occur if the API version already exists.\n",
|
|
26
|
-
"strict": true,
|
|
27
|
-
"pluginName": "swaggerhub-cli",
|
|
16
|
+
"hasDynamicHelp": false,
|
|
17
|
+
"hiddenAliases": [],
|
|
18
|
+
"id": "configure",
|
|
28
19
|
"pluginAlias": "swaggerhub-cli",
|
|
20
|
+
"pluginName": "swaggerhub-cli",
|
|
29
21
|
"pluginType": "core",
|
|
22
|
+
"strict": true,
|
|
23
|
+
"enableJsonFlag": false,
|
|
24
|
+
"isESM": false,
|
|
25
|
+
"relativePath": [
|
|
26
|
+
"src",
|
|
27
|
+
"commands",
|
|
28
|
+
"configure.js"
|
|
29
|
+
]
|
|
30
|
+
},
|
|
31
|
+
"api:create": {
|
|
30
32
|
"aliases": [],
|
|
33
|
+
"args": {
|
|
34
|
+
"OWNER/API_NAME/[VERSION]": {
|
|
35
|
+
"description": "API to create on SwaggerHub",
|
|
36
|
+
"name": "OWNER/API_NAME/[VERSION]",
|
|
37
|
+
"required": true
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
"description": "creates a new API / API version from a YAML/JSON file\nThe API version from the file will be used unless the version is specified in the command argument.\nAn error will occur if the API version already exists.\n",
|
|
31
41
|
"examples": [
|
|
32
42
|
"swaggerhub api:create organization/api/1.0.0 --file api.yaml --visibility public",
|
|
33
43
|
"swaggerhub api:create organization/api --file api.yaml",
|
|
@@ -36,246 +46,305 @@
|
|
|
36
46
|
"swaggerhub api:create organization/api/1.0.0 --published=publish --setdefault --file api.json"
|
|
37
47
|
],
|
|
38
48
|
"flags": {
|
|
39
|
-
"help": {
|
|
40
|
-
"name": "help",
|
|
41
|
-
"type": "boolean",
|
|
42
|
-
"char": "h",
|
|
43
|
-
"description": "Show CLI help.",
|
|
44
|
-
"allowNo": false
|
|
45
|
-
},
|
|
46
49
|
"file": {
|
|
47
|
-
"name": "file",
|
|
48
|
-
"type": "option",
|
|
49
50
|
"char": "f",
|
|
50
51
|
"description": "file location of API to create",
|
|
52
|
+
"name": "file",
|
|
51
53
|
"required": true,
|
|
52
|
-
"
|
|
54
|
+
"hasDynamicHelp": false,
|
|
55
|
+
"multiple": false,
|
|
56
|
+
"type": "option"
|
|
53
57
|
},
|
|
54
58
|
"visibility": {
|
|
55
|
-
"name": "visibility",
|
|
56
|
-
"type": "option",
|
|
57
59
|
"description": "visibility of API in SwaggerHub",
|
|
60
|
+
"name": "visibility",
|
|
61
|
+
"default": "private",
|
|
62
|
+
"hasDynamicHelp": false,
|
|
58
63
|
"multiple": false,
|
|
59
64
|
"options": [
|
|
60
65
|
"public",
|
|
61
66
|
"private"
|
|
62
67
|
],
|
|
63
|
-
"
|
|
68
|
+
"type": "option"
|
|
64
69
|
},
|
|
65
70
|
"published": {
|
|
66
|
-
"
|
|
67
|
-
|
|
71
|
+
"dependsOn": [
|
|
72
|
+
"file"
|
|
73
|
+
],
|
|
68
74
|
"description": "sets the lifecycle setting of the API version",
|
|
75
|
+
"name": "published",
|
|
69
76
|
"required": false,
|
|
77
|
+
"default": "unpublish",
|
|
78
|
+
"hasDynamicHelp": false,
|
|
70
79
|
"multiple": false,
|
|
71
80
|
"options": [
|
|
72
81
|
"publish",
|
|
73
82
|
"unpublish"
|
|
74
83
|
],
|
|
84
|
+
"type": "option"
|
|
85
|
+
},
|
|
86
|
+
"setdefault": {
|
|
75
87
|
"dependsOn": [
|
|
76
88
|
"file"
|
|
77
89
|
],
|
|
78
|
-
"default": "unpublish"
|
|
79
|
-
},
|
|
80
|
-
"setdefault": {
|
|
81
|
-
"name": "setdefault",
|
|
82
|
-
"type": "boolean",
|
|
83
90
|
"description": "sets API version to be the default",
|
|
91
|
+
"name": "setdefault",
|
|
84
92
|
"required": false,
|
|
85
93
|
"allowNo": false,
|
|
86
|
-
"
|
|
87
|
-
|
|
88
|
-
|
|
94
|
+
"type": "boolean"
|
|
95
|
+
},
|
|
96
|
+
"help": {
|
|
97
|
+
"char": "h",
|
|
98
|
+
"description": "Show CLI help.",
|
|
99
|
+
"name": "help",
|
|
100
|
+
"allowNo": false,
|
|
101
|
+
"type": "boolean"
|
|
89
102
|
}
|
|
90
103
|
},
|
|
104
|
+
"hasDynamicHelp": false,
|
|
105
|
+
"hiddenAliases": [],
|
|
106
|
+
"id": "api:create",
|
|
107
|
+
"pluginAlias": "swaggerhub-cli",
|
|
108
|
+
"pluginName": "swaggerhub-cli",
|
|
109
|
+
"pluginType": "core",
|
|
110
|
+
"strict": true,
|
|
111
|
+
"isESM": false,
|
|
112
|
+
"relativePath": [
|
|
113
|
+
"src",
|
|
114
|
+
"commands",
|
|
115
|
+
"api",
|
|
116
|
+
"create.js"
|
|
117
|
+
]
|
|
118
|
+
},
|
|
119
|
+
"api:delete": {
|
|
120
|
+
"aliases": [],
|
|
91
121
|
"args": {
|
|
92
122
|
"OWNER/API_NAME/[VERSION]": {
|
|
123
|
+
"description": "API to delete on SwaggerHub",
|
|
93
124
|
"name": "OWNER/API_NAME/[VERSION]",
|
|
94
|
-
"description": "API to create on SwaggerHub",
|
|
95
125
|
"required": true
|
|
96
126
|
}
|
|
97
|
-
}
|
|
98
|
-
},
|
|
99
|
-
"api:delete": {
|
|
100
|
-
"id": "api:delete",
|
|
127
|
+
},
|
|
101
128
|
"description": "delete an API or API version\n",
|
|
102
|
-
"strict": true,
|
|
103
|
-
"pluginName": "swaggerhub-cli",
|
|
104
|
-
"pluginAlias": "swaggerhub-cli",
|
|
105
|
-
"pluginType": "core",
|
|
106
|
-
"aliases": [],
|
|
107
129
|
"examples": [
|
|
108
130
|
"swaggerhub api:delete organization/api/1.0.0",
|
|
109
131
|
"swaggerhub api:delete organization/api",
|
|
110
132
|
"swaggerhub api:delete organization/api --force"
|
|
111
133
|
],
|
|
112
134
|
"flags": {
|
|
113
|
-
"help": {
|
|
114
|
-
"name": "help",
|
|
115
|
-
"type": "boolean",
|
|
116
|
-
"char": "h",
|
|
117
|
-
"description": "Show CLI help.",
|
|
118
|
-
"allowNo": false
|
|
119
|
-
},
|
|
120
135
|
"force": {
|
|
121
|
-
"name": "force",
|
|
122
|
-
"type": "boolean",
|
|
123
136
|
"char": "f",
|
|
124
137
|
"description": "delete API without prompting for confirmation",
|
|
125
|
-
"
|
|
138
|
+
"name": "force",
|
|
139
|
+
"allowNo": false,
|
|
140
|
+
"type": "boolean"
|
|
141
|
+
},
|
|
142
|
+
"help": {
|
|
143
|
+
"char": "h",
|
|
144
|
+
"description": "Show CLI help.",
|
|
145
|
+
"name": "help",
|
|
146
|
+
"allowNo": false,
|
|
147
|
+
"type": "boolean"
|
|
126
148
|
}
|
|
127
149
|
},
|
|
150
|
+
"hasDynamicHelp": false,
|
|
151
|
+
"hiddenAliases": [],
|
|
152
|
+
"id": "api:delete",
|
|
153
|
+
"pluginAlias": "swaggerhub-cli",
|
|
154
|
+
"pluginName": "swaggerhub-cli",
|
|
155
|
+
"pluginType": "core",
|
|
156
|
+
"strict": true,
|
|
157
|
+
"enableJsonFlag": false,
|
|
158
|
+
"isESM": false,
|
|
159
|
+
"relativePath": [
|
|
160
|
+
"src",
|
|
161
|
+
"commands",
|
|
162
|
+
"api",
|
|
163
|
+
"delete.js"
|
|
164
|
+
]
|
|
165
|
+
},
|
|
166
|
+
"api:get": {
|
|
167
|
+
"aliases": [],
|
|
128
168
|
"args": {
|
|
129
169
|
"OWNER/API_NAME/[VERSION]": {
|
|
170
|
+
"description": "API to fetch from Swaggerhub",
|
|
130
171
|
"name": "OWNER/API_NAME/[VERSION]",
|
|
131
|
-
"description": "API to delete on SwaggerHub",
|
|
132
172
|
"required": true
|
|
133
173
|
}
|
|
134
|
-
}
|
|
135
|
-
},
|
|
136
|
-
"api:get": {
|
|
137
|
-
"id": "api:get",
|
|
174
|
+
},
|
|
138
175
|
"description": "fetches an API definition\nWhen VERSION is not included in the argument, the default version will be returned.\nReturns the API in YAML format by default.\n",
|
|
139
|
-
"strict": true,
|
|
140
|
-
"pluginName": "swaggerhub-cli",
|
|
141
|
-
"pluginAlias": "swaggerhub-cli",
|
|
142
|
-
"pluginType": "core",
|
|
143
|
-
"aliases": [],
|
|
144
176
|
"examples": [
|
|
145
177
|
"swaggerhub api:get organization/api",
|
|
146
178
|
"swaggerhub api:get organization/api/1.0.0 --json"
|
|
147
179
|
],
|
|
148
180
|
"flags": {
|
|
149
|
-
"help": {
|
|
150
|
-
"name": "help",
|
|
151
|
-
"type": "boolean",
|
|
152
|
-
"char": "h",
|
|
153
|
-
"description": "Show CLI help.",
|
|
154
|
-
"allowNo": false
|
|
155
|
-
},
|
|
156
181
|
"json": {
|
|
157
|
-
"name": "json",
|
|
158
|
-
"type": "boolean",
|
|
159
182
|
"char": "j",
|
|
160
183
|
"description": "returns the API in JSON format.",
|
|
161
|
-
"
|
|
184
|
+
"name": "json",
|
|
185
|
+
"allowNo": false,
|
|
186
|
+
"type": "boolean"
|
|
162
187
|
},
|
|
163
188
|
"resolved": {
|
|
164
|
-
"name": "resolved",
|
|
165
|
-
"type": "boolean",
|
|
166
189
|
"char": "r",
|
|
167
190
|
"description": "gets the resolved API definition (supported in v1.25+). ",
|
|
168
|
-
"
|
|
191
|
+
"name": "resolved",
|
|
192
|
+
"allowNo": false,
|
|
193
|
+
"type": "boolean"
|
|
194
|
+
},
|
|
195
|
+
"help": {
|
|
196
|
+
"char": "h",
|
|
197
|
+
"description": "Show CLI help.",
|
|
198
|
+
"name": "help",
|
|
199
|
+
"allowNo": false,
|
|
200
|
+
"type": "boolean"
|
|
169
201
|
}
|
|
170
202
|
},
|
|
203
|
+
"hasDynamicHelp": false,
|
|
204
|
+
"hiddenAliases": [],
|
|
205
|
+
"id": "api:get",
|
|
206
|
+
"pluginAlias": "swaggerhub-cli",
|
|
207
|
+
"pluginName": "swaggerhub-cli",
|
|
208
|
+
"pluginType": "core",
|
|
209
|
+
"strict": true,
|
|
210
|
+
"enableJsonFlag": false,
|
|
211
|
+
"isESM": false,
|
|
212
|
+
"relativePath": [
|
|
213
|
+
"src",
|
|
214
|
+
"commands",
|
|
215
|
+
"api",
|
|
216
|
+
"get.js"
|
|
217
|
+
]
|
|
218
|
+
},
|
|
219
|
+
"api:publish": {
|
|
220
|
+
"aliases": [],
|
|
171
221
|
"args": {
|
|
172
|
-
"OWNER/API_NAME/
|
|
173
|
-
"
|
|
174
|
-
"
|
|
222
|
+
"OWNER/API_NAME/VERSION": {
|
|
223
|
+
"description": "API to publish on Swaggerhub",
|
|
224
|
+
"name": "OWNER/API_NAME/VERSION",
|
|
175
225
|
"required": true
|
|
176
226
|
}
|
|
177
|
-
}
|
|
178
|
-
},
|
|
179
|
-
"api:publish": {
|
|
180
|
-
"id": "api:publish",
|
|
227
|
+
},
|
|
181
228
|
"description": "publish an API version",
|
|
182
|
-
"strict": true,
|
|
183
|
-
"pluginName": "swaggerhub-cli",
|
|
184
|
-
"pluginAlias": "swaggerhub-cli",
|
|
185
|
-
"pluginType": "core",
|
|
186
|
-
"aliases": [],
|
|
187
229
|
"examples": [
|
|
188
230
|
"swaggerhub api:publish organization/api/1.0.0",
|
|
189
231
|
"swaggerhub api:publish organization/api/1.0.0 --force"
|
|
190
232
|
],
|
|
191
233
|
"flags": {
|
|
192
|
-
"help": {
|
|
193
|
-
"name": "help",
|
|
194
|
-
"type": "boolean",
|
|
195
|
-
"char": "h",
|
|
196
|
-
"description": "Show CLI help.",
|
|
197
|
-
"allowNo": false
|
|
198
|
-
},
|
|
199
234
|
"force": {
|
|
200
|
-
"name": "force",
|
|
201
|
-
"type": "boolean",
|
|
202
235
|
"char": "f",
|
|
203
236
|
"description": "publish API without prompting for confirmation",
|
|
204
|
-
"
|
|
237
|
+
"name": "force",
|
|
238
|
+
"allowNo": false,
|
|
239
|
+
"type": "boolean"
|
|
240
|
+
},
|
|
241
|
+
"help": {
|
|
242
|
+
"char": "h",
|
|
243
|
+
"description": "Show CLI help.",
|
|
244
|
+
"name": "help",
|
|
245
|
+
"allowNo": false,
|
|
246
|
+
"type": "boolean"
|
|
205
247
|
}
|
|
206
248
|
},
|
|
249
|
+
"hasDynamicHelp": false,
|
|
250
|
+
"hiddenAliases": [],
|
|
251
|
+
"id": "api:publish",
|
|
252
|
+
"pluginAlias": "swaggerhub-cli",
|
|
253
|
+
"pluginName": "swaggerhub-cli",
|
|
254
|
+
"pluginType": "core",
|
|
255
|
+
"strict": true,
|
|
256
|
+
"isESM": false,
|
|
257
|
+
"relativePath": [
|
|
258
|
+
"src",
|
|
259
|
+
"commands",
|
|
260
|
+
"api",
|
|
261
|
+
"publish.js"
|
|
262
|
+
]
|
|
263
|
+
},
|
|
264
|
+
"api:setdefault": {
|
|
265
|
+
"aliases": [],
|
|
207
266
|
"args": {
|
|
208
267
|
"OWNER/API_NAME/VERSION": {
|
|
268
|
+
"description": "API to set as default on Swaggerhub",
|
|
209
269
|
"name": "OWNER/API_NAME/VERSION",
|
|
210
|
-
"description": "API to publish on Swaggerhub",
|
|
211
270
|
"required": true
|
|
212
271
|
}
|
|
213
|
-
}
|
|
214
|
-
},
|
|
215
|
-
"api:setdefault": {
|
|
216
|
-
"id": "api:setdefault",
|
|
272
|
+
},
|
|
217
273
|
"description": "set the default version of an API",
|
|
218
|
-
"strict": true,
|
|
219
|
-
"pluginName": "swaggerhub-cli",
|
|
220
|
-
"pluginAlias": "swaggerhub-cli",
|
|
221
|
-
"pluginType": "core",
|
|
222
|
-
"aliases": [],
|
|
223
274
|
"examples": [
|
|
224
275
|
"swaggerhub api:setdefault organization/api/2.0.0"
|
|
225
276
|
],
|
|
226
277
|
"flags": {
|
|
227
278
|
"help": {
|
|
228
|
-
"name": "help",
|
|
229
|
-
"type": "boolean",
|
|
230
279
|
"char": "h",
|
|
231
280
|
"description": "Show CLI help.",
|
|
232
|
-
"
|
|
281
|
+
"name": "help",
|
|
282
|
+
"allowNo": false,
|
|
283
|
+
"type": "boolean"
|
|
233
284
|
}
|
|
234
285
|
},
|
|
286
|
+
"hasDynamicHelp": false,
|
|
287
|
+
"hiddenAliases": [],
|
|
288
|
+
"id": "api:setdefault",
|
|
289
|
+
"pluginAlias": "swaggerhub-cli",
|
|
290
|
+
"pluginName": "swaggerhub-cli",
|
|
291
|
+
"pluginType": "core",
|
|
292
|
+
"strict": true,
|
|
293
|
+
"isESM": false,
|
|
294
|
+
"relativePath": [
|
|
295
|
+
"src",
|
|
296
|
+
"commands",
|
|
297
|
+
"api",
|
|
298
|
+
"setdefault.js"
|
|
299
|
+
]
|
|
300
|
+
},
|
|
301
|
+
"api:unpublish": {
|
|
302
|
+
"aliases": [],
|
|
235
303
|
"args": {
|
|
236
304
|
"OWNER/API_NAME/VERSION": {
|
|
305
|
+
"description": "API identifier",
|
|
237
306
|
"name": "OWNER/API_NAME/VERSION",
|
|
238
|
-
"description": "API to set as default on Swaggerhub",
|
|
239
307
|
"required": true
|
|
240
308
|
}
|
|
241
|
-
}
|
|
242
|
-
},
|
|
243
|
-
"api:unpublish": {
|
|
244
|
-
"id": "api:unpublish",
|
|
309
|
+
},
|
|
245
310
|
"description": "unpublish an API version",
|
|
246
|
-
"strict": true,
|
|
247
|
-
"pluginName": "swaggerhub-cli",
|
|
248
|
-
"pluginAlias": "swaggerhub-cli",
|
|
249
|
-
"pluginType": "core",
|
|
250
|
-
"aliases": [],
|
|
251
311
|
"examples": [
|
|
252
312
|
"swaggerhub api:unpublish organization/api/1.0.0"
|
|
253
313
|
],
|
|
254
314
|
"flags": {
|
|
255
315
|
"help": {
|
|
256
|
-
"name": "help",
|
|
257
|
-
"type": "boolean",
|
|
258
316
|
"char": "h",
|
|
259
317
|
"description": "Show CLI help.",
|
|
260
|
-
"
|
|
318
|
+
"name": "help",
|
|
319
|
+
"allowNo": false,
|
|
320
|
+
"type": "boolean"
|
|
261
321
|
}
|
|
262
322
|
},
|
|
323
|
+
"hasDynamicHelp": false,
|
|
324
|
+
"hiddenAliases": [],
|
|
325
|
+
"id": "api:unpublish",
|
|
326
|
+
"pluginAlias": "swaggerhub-cli",
|
|
327
|
+
"pluginName": "swaggerhub-cli",
|
|
328
|
+
"pluginType": "core",
|
|
329
|
+
"strict": true,
|
|
330
|
+
"isESM": false,
|
|
331
|
+
"relativePath": [
|
|
332
|
+
"src",
|
|
333
|
+
"commands",
|
|
334
|
+
"api",
|
|
335
|
+
"unpublish.js"
|
|
336
|
+
]
|
|
337
|
+
},
|
|
338
|
+
"api:update": {
|
|
339
|
+
"aliases": [],
|
|
263
340
|
"args": {
|
|
264
|
-
"OWNER/API_NAME/VERSION": {
|
|
265
|
-
"
|
|
266
|
-
"
|
|
341
|
+
"OWNER/API_NAME/[VERSION]": {
|
|
342
|
+
"description": "API to update on SwaggerHub",
|
|
343
|
+
"name": "OWNER/API_NAME/[VERSION]",
|
|
267
344
|
"required": true
|
|
268
345
|
}
|
|
269
|
-
}
|
|
270
|
-
},
|
|
271
|
-
"api:update": {
|
|
272
|
-
"id": "api:update",
|
|
346
|
+
},
|
|
273
347
|
"description": "update an API\nThe API version from the file will be used unless the version is specified in the command argument.\nWhen no file is specified then the default API version will be updated.\nThe API visibility can be changed by using visibility flag.\n",
|
|
274
|
-
"strict": true,
|
|
275
|
-
"pluginName": "swaggerhub-cli",
|
|
276
|
-
"pluginAlias": "swaggerhub-cli",
|
|
277
|
-
"pluginType": "core",
|
|
278
|
-
"aliases": [],
|
|
279
348
|
"examples": [
|
|
280
349
|
"swaggerhub api:update organization/api --file api.yaml",
|
|
281
350
|
"swaggerhub api:update organization/api/1.0.0 --file api.json",
|
|
@@ -285,66 +354,78 @@
|
|
|
285
354
|
"swaggerhub api:update organization/api/1.0.0 --visibility=private"
|
|
286
355
|
],
|
|
287
356
|
"flags": {
|
|
288
|
-
"help": {
|
|
289
|
-
"name": "help",
|
|
290
|
-
"type": "boolean",
|
|
291
|
-
"char": "h",
|
|
292
|
-
"description": "Show CLI help.",
|
|
293
|
-
"allowNo": false
|
|
294
|
-
},
|
|
295
357
|
"file": {
|
|
296
|
-
"name": "file",
|
|
297
|
-
"type": "option",
|
|
298
358
|
"char": "f",
|
|
299
359
|
"description": "file location of API to update",
|
|
360
|
+
"name": "file",
|
|
300
361
|
"required": false,
|
|
301
|
-
"
|
|
362
|
+
"hasDynamicHelp": false,
|
|
363
|
+
"multiple": false,
|
|
364
|
+
"type": "option"
|
|
302
365
|
},
|
|
303
366
|
"visibility": {
|
|
304
|
-
"name": "visibility",
|
|
305
|
-
"type": "option",
|
|
306
367
|
"description": "visibility of API in SwaggerHub",
|
|
368
|
+
"name": "visibility",
|
|
369
|
+
"hasDynamicHelp": false,
|
|
307
370
|
"multiple": false,
|
|
308
371
|
"options": [
|
|
309
372
|
"public",
|
|
310
373
|
"private"
|
|
311
|
-
]
|
|
374
|
+
],
|
|
375
|
+
"type": "option"
|
|
312
376
|
},
|
|
313
377
|
"published": {
|
|
314
|
-
"name": "published",
|
|
315
|
-
"type": "option",
|
|
316
378
|
"description": "sets the lifecycle setting of the API version",
|
|
379
|
+
"name": "published",
|
|
317
380
|
"required": false,
|
|
381
|
+
"hasDynamicHelp": false,
|
|
318
382
|
"multiple": false,
|
|
319
383
|
"options": [
|
|
320
384
|
"publish",
|
|
321
385
|
"unpublish"
|
|
322
|
-
]
|
|
386
|
+
],
|
|
387
|
+
"type": "option"
|
|
323
388
|
},
|
|
324
389
|
"setdefault": {
|
|
325
|
-
"name": "setdefault",
|
|
326
|
-
"type": "boolean",
|
|
327
390
|
"description": "sets API version to be the default",
|
|
391
|
+
"name": "setdefault",
|
|
328
392
|
"required": false,
|
|
329
|
-
"allowNo": false
|
|
393
|
+
"allowNo": false,
|
|
394
|
+
"type": "boolean"
|
|
395
|
+
},
|
|
396
|
+
"help": {
|
|
397
|
+
"char": "h",
|
|
398
|
+
"description": "Show CLI help.",
|
|
399
|
+
"name": "help",
|
|
400
|
+
"allowNo": false,
|
|
401
|
+
"type": "boolean"
|
|
330
402
|
}
|
|
331
403
|
},
|
|
332
|
-
"
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
"description": "API to update on SwaggerHub",
|
|
336
|
-
"required": true
|
|
337
|
-
}
|
|
338
|
-
}
|
|
339
|
-
},
|
|
340
|
-
"domain:create": {
|
|
341
|
-
"id": "domain:create",
|
|
342
|
-
"description": "creates a new domain / domain version from a YAML/JSON file\nThe domain version from the file will be used unless the version is specified in the command argument.\nAn error will occur if the domain version already exists.\n",
|
|
343
|
-
"strict": true,
|
|
344
|
-
"pluginName": "swaggerhub-cli",
|
|
404
|
+
"hasDynamicHelp": false,
|
|
405
|
+
"hiddenAliases": [],
|
|
406
|
+
"id": "api:update",
|
|
345
407
|
"pluginAlias": "swaggerhub-cli",
|
|
408
|
+
"pluginName": "swaggerhub-cli",
|
|
346
409
|
"pluginType": "core",
|
|
410
|
+
"strict": true,
|
|
411
|
+
"isESM": false,
|
|
412
|
+
"relativePath": [
|
|
413
|
+
"src",
|
|
414
|
+
"commands",
|
|
415
|
+
"api",
|
|
416
|
+
"update.js"
|
|
417
|
+
]
|
|
418
|
+
},
|
|
419
|
+
"domain:create": {
|
|
347
420
|
"aliases": [],
|
|
421
|
+
"args": {
|
|
422
|
+
"OWNER/DOMAIN_NAME/[VERSION]": {
|
|
423
|
+
"description": "Domain to create on SwaggerHub",
|
|
424
|
+
"name": "OWNER/DOMAIN_NAME/[VERSION]",
|
|
425
|
+
"required": true
|
|
426
|
+
}
|
|
427
|
+
},
|
|
428
|
+
"description": "creates a new domain / domain version from a YAML/JSON file\nThe domain version from the file will be used unless the version is specified in the command argument.\nAn error will occur if the domain version already exists.\n",
|
|
348
429
|
"examples": [
|
|
349
430
|
"swaggerhub domain:create organization/domain/1.0.0 --file domain.yaml --visibility public",
|
|
350
431
|
"swaggerhub domain:create organization/domain --file domain.yaml",
|
|
@@ -353,231 +434,290 @@
|
|
|
353
434
|
"swaggerhub domain:create organization/domain/1.0.0 --publish --setdefault --file domain.json"
|
|
354
435
|
],
|
|
355
436
|
"flags": {
|
|
356
|
-
"help": {
|
|
357
|
-
"name": "help",
|
|
358
|
-
"type": "boolean",
|
|
359
|
-
"char": "h",
|
|
360
|
-
"description": "Show CLI help.",
|
|
361
|
-
"allowNo": false
|
|
362
|
-
},
|
|
363
437
|
"file": {
|
|
364
|
-
"name": "file",
|
|
365
|
-
"type": "option",
|
|
366
438
|
"char": "f",
|
|
367
439
|
"description": "file location of domain to create",
|
|
440
|
+
"name": "file",
|
|
368
441
|
"required": true,
|
|
369
|
-
"
|
|
442
|
+
"hasDynamicHelp": false,
|
|
443
|
+
"multiple": false,
|
|
444
|
+
"type": "option"
|
|
370
445
|
},
|
|
371
446
|
"visibility": {
|
|
372
|
-
"name": "visibility",
|
|
373
|
-
"type": "option",
|
|
374
447
|
"description": "visibility of domain in SwaggerHub",
|
|
448
|
+
"name": "visibility",
|
|
449
|
+
"default": "private",
|
|
450
|
+
"hasDynamicHelp": false,
|
|
375
451
|
"multiple": false,
|
|
376
452
|
"options": [
|
|
377
453
|
"public",
|
|
378
454
|
"private"
|
|
379
455
|
],
|
|
380
|
-
"
|
|
456
|
+
"type": "option"
|
|
381
457
|
},
|
|
382
458
|
"published": {
|
|
383
|
-
"
|
|
384
|
-
|
|
459
|
+
"dependsOn": [
|
|
460
|
+
"file"
|
|
461
|
+
],
|
|
385
462
|
"description": "sets the lifecycle setting of the domain version",
|
|
463
|
+
"name": "published",
|
|
386
464
|
"required": false,
|
|
465
|
+
"default": "unpublish",
|
|
466
|
+
"hasDynamicHelp": false,
|
|
387
467
|
"multiple": false,
|
|
388
468
|
"options": [
|
|
389
469
|
"publish",
|
|
390
470
|
"unpublish"
|
|
391
471
|
],
|
|
472
|
+
"type": "option"
|
|
473
|
+
},
|
|
474
|
+
"setdefault": {
|
|
392
475
|
"dependsOn": [
|
|
393
476
|
"file"
|
|
394
477
|
],
|
|
395
|
-
"default": "unpublish"
|
|
396
|
-
},
|
|
397
|
-
"setdefault": {
|
|
398
|
-
"name": "setdefault",
|
|
399
|
-
"type": "boolean",
|
|
400
478
|
"description": "sets domain version to be the default",
|
|
479
|
+
"name": "setdefault",
|
|
401
480
|
"required": false,
|
|
402
481
|
"allowNo": false,
|
|
403
|
-
"
|
|
404
|
-
|
|
405
|
-
|
|
482
|
+
"type": "boolean"
|
|
483
|
+
},
|
|
484
|
+
"help": {
|
|
485
|
+
"char": "h",
|
|
486
|
+
"description": "Show CLI help.",
|
|
487
|
+
"name": "help",
|
|
488
|
+
"allowNo": false,
|
|
489
|
+
"type": "boolean"
|
|
406
490
|
}
|
|
407
491
|
},
|
|
492
|
+
"hasDynamicHelp": false,
|
|
493
|
+
"hiddenAliases": [],
|
|
494
|
+
"id": "domain:create",
|
|
495
|
+
"pluginAlias": "swaggerhub-cli",
|
|
496
|
+
"pluginName": "swaggerhub-cli",
|
|
497
|
+
"pluginType": "core",
|
|
498
|
+
"strict": true,
|
|
499
|
+
"isESM": false,
|
|
500
|
+
"relativePath": [
|
|
501
|
+
"src",
|
|
502
|
+
"commands",
|
|
503
|
+
"domain",
|
|
504
|
+
"create.js"
|
|
505
|
+
]
|
|
506
|
+
},
|
|
507
|
+
"domain:delete": {
|
|
508
|
+
"aliases": [],
|
|
408
509
|
"args": {
|
|
409
510
|
"OWNER/DOMAIN_NAME/[VERSION]": {
|
|
511
|
+
"description": "Domain to delete on SwaggerHub",
|
|
410
512
|
"name": "OWNER/DOMAIN_NAME/[VERSION]",
|
|
411
|
-
"description": "Domain to create on SwaggerHub",
|
|
412
513
|
"required": true
|
|
413
514
|
}
|
|
414
|
-
}
|
|
415
|
-
},
|
|
416
|
-
"domain:delete": {
|
|
417
|
-
"id": "domain:delete",
|
|
515
|
+
},
|
|
418
516
|
"description": "delete a domain or domain version\n",
|
|
419
|
-
"strict": true,
|
|
420
|
-
"pluginName": "swaggerhub-cli",
|
|
421
|
-
"pluginAlias": "swaggerhub-cli",
|
|
422
|
-
"pluginType": "core",
|
|
423
|
-
"aliases": [],
|
|
424
517
|
"examples": [
|
|
425
518
|
"swaggerhub domain:delete organization/domain/1.0.0",
|
|
426
519
|
"swaggerhub domain:delete organization/domain",
|
|
427
520
|
"swaggerhub domain:delete organization/domain --force"
|
|
428
521
|
],
|
|
429
522
|
"flags": {
|
|
430
|
-
"help": {
|
|
431
|
-
"name": "help",
|
|
432
|
-
"type": "boolean",
|
|
433
|
-
"char": "h",
|
|
434
|
-
"description": "Show CLI help.",
|
|
435
|
-
"allowNo": false
|
|
436
|
-
},
|
|
437
523
|
"force": {
|
|
438
|
-
"name": "force",
|
|
439
|
-
"type": "boolean",
|
|
440
524
|
"char": "f",
|
|
441
525
|
"description": "delete domain without prompting for confirmation",
|
|
442
|
-
"
|
|
526
|
+
"name": "force",
|
|
527
|
+
"allowNo": false,
|
|
528
|
+
"type": "boolean"
|
|
529
|
+
},
|
|
530
|
+
"help": {
|
|
531
|
+
"char": "h",
|
|
532
|
+
"description": "Show CLI help.",
|
|
533
|
+
"name": "help",
|
|
534
|
+
"allowNo": false,
|
|
535
|
+
"type": "boolean"
|
|
443
536
|
}
|
|
444
537
|
},
|
|
538
|
+
"hasDynamicHelp": false,
|
|
539
|
+
"hiddenAliases": [],
|
|
540
|
+
"id": "domain:delete",
|
|
541
|
+
"pluginAlias": "swaggerhub-cli",
|
|
542
|
+
"pluginName": "swaggerhub-cli",
|
|
543
|
+
"pluginType": "core",
|
|
544
|
+
"strict": true,
|
|
545
|
+
"enableJsonFlag": false,
|
|
546
|
+
"isESM": false,
|
|
547
|
+
"relativePath": [
|
|
548
|
+
"src",
|
|
549
|
+
"commands",
|
|
550
|
+
"domain",
|
|
551
|
+
"delete.js"
|
|
552
|
+
]
|
|
553
|
+
},
|
|
554
|
+
"domain:get": {
|
|
555
|
+
"aliases": [],
|
|
445
556
|
"args": {
|
|
446
557
|
"OWNER/DOMAIN_NAME/[VERSION]": {
|
|
558
|
+
"description": "Domain to fetch from SwaggerHub",
|
|
447
559
|
"name": "OWNER/DOMAIN_NAME/[VERSION]",
|
|
448
|
-
"description": "Domain to delete on SwaggerHub",
|
|
449
560
|
"required": true
|
|
450
561
|
}
|
|
451
|
-
}
|
|
452
|
-
},
|
|
453
|
-
"domain:get": {
|
|
454
|
-
"id": "domain:get",
|
|
562
|
+
},
|
|
455
563
|
"description": "fetches a domain definition\nWhen VERSION is not included in the argument, the default version will be returned.\nReturns the domain in YAML format by default.\n",
|
|
456
|
-
"strict": true,
|
|
457
|
-
"pluginName": "swaggerhub-cli",
|
|
458
|
-
"pluginAlias": "swaggerhub-cli",
|
|
459
|
-
"pluginType": "core",
|
|
460
|
-
"aliases": [],
|
|
461
564
|
"examples": [
|
|
462
565
|
"swaggerhub domain:get organization/domain",
|
|
463
566
|
"swaggerhub domain:get organization/domain/1.0.0 --json"
|
|
464
567
|
],
|
|
465
568
|
"flags": {
|
|
466
|
-
"help": {
|
|
467
|
-
"name": "help",
|
|
468
|
-
"type": "boolean",
|
|
469
|
-
"char": "h",
|
|
470
|
-
"description": "Show CLI help.",
|
|
471
|
-
"allowNo": false
|
|
472
|
-
},
|
|
473
569
|
"json": {
|
|
474
|
-
"name": "json",
|
|
475
|
-
"type": "boolean",
|
|
476
570
|
"char": "j",
|
|
477
571
|
"description": "returns the domain in JSON format.",
|
|
478
|
-
"
|
|
572
|
+
"name": "json",
|
|
573
|
+
"allowNo": false,
|
|
574
|
+
"type": "boolean"
|
|
575
|
+
},
|
|
576
|
+
"help": {
|
|
577
|
+
"char": "h",
|
|
578
|
+
"description": "Show CLI help.",
|
|
579
|
+
"name": "help",
|
|
580
|
+
"allowNo": false,
|
|
581
|
+
"type": "boolean"
|
|
479
582
|
}
|
|
480
583
|
},
|
|
584
|
+
"hasDynamicHelp": false,
|
|
585
|
+
"hiddenAliases": [],
|
|
586
|
+
"id": "domain:get",
|
|
587
|
+
"pluginAlias": "swaggerhub-cli",
|
|
588
|
+
"pluginName": "swaggerhub-cli",
|
|
589
|
+
"pluginType": "core",
|
|
590
|
+
"strict": true,
|
|
591
|
+
"enableJsonFlag": false,
|
|
592
|
+
"isESM": false,
|
|
593
|
+
"relativePath": [
|
|
594
|
+
"src",
|
|
595
|
+
"commands",
|
|
596
|
+
"domain",
|
|
597
|
+
"get.js"
|
|
598
|
+
]
|
|
599
|
+
},
|
|
600
|
+
"domain:publish": {
|
|
601
|
+
"aliases": [],
|
|
481
602
|
"args": {
|
|
482
|
-
"OWNER/DOMAIN_NAME/
|
|
483
|
-
"
|
|
484
|
-
"
|
|
603
|
+
"OWNER/DOMAIN_NAME/VERSION": {
|
|
604
|
+
"description": "Domain to publish on SwaggerHub",
|
|
605
|
+
"name": "OWNER/DOMAIN_NAME/VERSION",
|
|
485
606
|
"required": true
|
|
486
607
|
}
|
|
487
|
-
}
|
|
488
|
-
},
|
|
489
|
-
"domain:publish": {
|
|
490
|
-
"id": "domain:publish",
|
|
608
|
+
},
|
|
491
609
|
"description": "publish a domain version",
|
|
492
|
-
"strict": true,
|
|
493
|
-
"pluginName": "swaggerhub-cli",
|
|
494
|
-
"pluginAlias": "swaggerhub-cli",
|
|
495
|
-
"pluginType": "core",
|
|
496
|
-
"aliases": [],
|
|
497
610
|
"examples": [
|
|
498
611
|
"swaggerhub domain:publish organization/domain/1.0.0"
|
|
499
612
|
],
|
|
500
613
|
"flags": {
|
|
501
614
|
"help": {
|
|
502
|
-
"name": "help",
|
|
503
|
-
"type": "boolean",
|
|
504
615
|
"char": "h",
|
|
505
616
|
"description": "Show CLI help.",
|
|
506
|
-
"
|
|
617
|
+
"name": "help",
|
|
618
|
+
"allowNo": false,
|
|
619
|
+
"type": "boolean"
|
|
507
620
|
}
|
|
508
621
|
},
|
|
622
|
+
"hasDynamicHelp": false,
|
|
623
|
+
"hiddenAliases": [],
|
|
624
|
+
"id": "domain:publish",
|
|
625
|
+
"pluginAlias": "swaggerhub-cli",
|
|
626
|
+
"pluginName": "swaggerhub-cli",
|
|
627
|
+
"pluginType": "core",
|
|
628
|
+
"strict": true,
|
|
629
|
+
"isESM": false,
|
|
630
|
+
"relativePath": [
|
|
631
|
+
"src",
|
|
632
|
+
"commands",
|
|
633
|
+
"domain",
|
|
634
|
+
"publish.js"
|
|
635
|
+
]
|
|
636
|
+
},
|
|
637
|
+
"domain:setdefault": {
|
|
638
|
+
"aliases": [],
|
|
509
639
|
"args": {
|
|
510
640
|
"OWNER/DOMAIN_NAME/VERSION": {
|
|
641
|
+
"description": "Domain to set as default on SwaggerHub",
|
|
511
642
|
"name": "OWNER/DOMAIN_NAME/VERSION",
|
|
512
|
-
"description": "Domain to publish on SwaggerHub",
|
|
513
643
|
"required": true
|
|
514
644
|
}
|
|
515
|
-
}
|
|
516
|
-
},
|
|
517
|
-
"domain:setdefault": {
|
|
518
|
-
"id": "domain:setdefault",
|
|
645
|
+
},
|
|
519
646
|
"description": "set the default version of a domain",
|
|
520
|
-
"strict": true,
|
|
521
|
-
"pluginName": "swaggerhub-cli",
|
|
522
|
-
"pluginAlias": "swaggerhub-cli",
|
|
523
|
-
"pluginType": "core",
|
|
524
|
-
"aliases": [],
|
|
525
647
|
"examples": [
|
|
526
648
|
"swaggerhub domain:setdefault organization/domain/2.0.0"
|
|
527
649
|
],
|
|
528
650
|
"flags": {
|
|
529
651
|
"help": {
|
|
530
|
-
"name": "help",
|
|
531
|
-
"type": "boolean",
|
|
532
652
|
"char": "h",
|
|
533
653
|
"description": "Show CLI help.",
|
|
534
|
-
"
|
|
654
|
+
"name": "help",
|
|
655
|
+
"allowNo": false,
|
|
656
|
+
"type": "boolean"
|
|
535
657
|
}
|
|
536
658
|
},
|
|
659
|
+
"hasDynamicHelp": false,
|
|
660
|
+
"hiddenAliases": [],
|
|
661
|
+
"id": "domain:setdefault",
|
|
662
|
+
"pluginAlias": "swaggerhub-cli",
|
|
663
|
+
"pluginName": "swaggerhub-cli",
|
|
664
|
+
"pluginType": "core",
|
|
665
|
+
"strict": true,
|
|
666
|
+
"isESM": false,
|
|
667
|
+
"relativePath": [
|
|
668
|
+
"src",
|
|
669
|
+
"commands",
|
|
670
|
+
"domain",
|
|
671
|
+
"setdefault.js"
|
|
672
|
+
]
|
|
673
|
+
},
|
|
674
|
+
"domain:unpublish": {
|
|
675
|
+
"aliases": [],
|
|
537
676
|
"args": {
|
|
538
677
|
"OWNER/DOMAIN_NAME/VERSION": {
|
|
678
|
+
"description": "Domain to unpublish on SwaggerHub",
|
|
539
679
|
"name": "OWNER/DOMAIN_NAME/VERSION",
|
|
540
|
-
"description": "Domain to set as default on SwaggerHub",
|
|
541
680
|
"required": true
|
|
542
681
|
}
|
|
543
|
-
}
|
|
544
|
-
},
|
|
545
|
-
"domain:unpublish": {
|
|
546
|
-
"id": "domain:unpublish",
|
|
682
|
+
},
|
|
547
683
|
"description": "unpublish a domain version",
|
|
548
|
-
"strict": true,
|
|
549
|
-
"pluginName": "swaggerhub-cli",
|
|
550
|
-
"pluginAlias": "swaggerhub-cli",
|
|
551
|
-
"pluginType": "core",
|
|
552
|
-
"aliases": [],
|
|
553
684
|
"examples": [
|
|
554
685
|
"swaggerhub domain:unpublish organization/domain/1.0.0"
|
|
555
686
|
],
|
|
556
687
|
"flags": {
|
|
557
688
|
"help": {
|
|
558
|
-
"name": "help",
|
|
559
|
-
"type": "boolean",
|
|
560
689
|
"char": "h",
|
|
561
690
|
"description": "Show CLI help.",
|
|
562
|
-
"
|
|
691
|
+
"name": "help",
|
|
692
|
+
"allowNo": false,
|
|
693
|
+
"type": "boolean"
|
|
563
694
|
}
|
|
564
695
|
},
|
|
696
|
+
"hasDynamicHelp": false,
|
|
697
|
+
"hiddenAliases": [],
|
|
698
|
+
"id": "domain:unpublish",
|
|
699
|
+
"pluginAlias": "swaggerhub-cli",
|
|
700
|
+
"pluginName": "swaggerhub-cli",
|
|
701
|
+
"pluginType": "core",
|
|
702
|
+
"strict": true,
|
|
703
|
+
"isESM": false,
|
|
704
|
+
"relativePath": [
|
|
705
|
+
"src",
|
|
706
|
+
"commands",
|
|
707
|
+
"domain",
|
|
708
|
+
"unpublish.js"
|
|
709
|
+
]
|
|
710
|
+
},
|
|
711
|
+
"domain:update": {
|
|
712
|
+
"aliases": [],
|
|
565
713
|
"args": {
|
|
566
|
-
"OWNER/DOMAIN_NAME/VERSION": {
|
|
567
|
-
"
|
|
568
|
-
"
|
|
714
|
+
"OWNER/DOMAIN_NAME/[VERSION]": {
|
|
715
|
+
"description": "Domain to update on SwaggerHub",
|
|
716
|
+
"name": "OWNER/DOMAIN_NAME/[VERSION]",
|
|
569
717
|
"required": true
|
|
570
718
|
}
|
|
571
|
-
}
|
|
572
|
-
},
|
|
573
|
-
"domain:update": {
|
|
574
|
-
"id": "domain:update",
|
|
719
|
+
},
|
|
575
720
|
"description": "update a domain\nThe domain version from the file will be used unless the version is specified in the command argument.\nWhen no file is specified then the default domain version will be updated.\nThe domain visibility can be changed by using visibility flag.\n",
|
|
576
|
-
"strict": true,
|
|
577
|
-
"pluginName": "swaggerhub-cli",
|
|
578
|
-
"pluginAlias": "swaggerhub-cli",
|
|
579
|
-
"pluginType": "core",
|
|
580
|
-
"aliases": [],
|
|
581
721
|
"examples": [
|
|
582
722
|
"swaggerhub domain:update organization/domain --file domain.yaml",
|
|
583
723
|
"swaggerhub domain:update organization/domain/1.0.0 --file domain.json",
|
|
@@ -587,250 +727,324 @@
|
|
|
587
727
|
"swaggerhub domain:update organization/domain/1.0.0 --visibility=private"
|
|
588
728
|
],
|
|
589
729
|
"flags": {
|
|
590
|
-
"help": {
|
|
591
|
-
"name": "help",
|
|
592
|
-
"type": "boolean",
|
|
593
|
-
"char": "h",
|
|
594
|
-
"description": "Show CLI help.",
|
|
595
|
-
"allowNo": false
|
|
596
|
-
},
|
|
597
730
|
"file": {
|
|
598
|
-
"name": "file",
|
|
599
|
-
"type": "option",
|
|
600
731
|
"char": "f",
|
|
601
732
|
"description": "file location of domain to update",
|
|
733
|
+
"name": "file",
|
|
602
734
|
"required": false,
|
|
603
|
-
"
|
|
735
|
+
"hasDynamicHelp": false,
|
|
736
|
+
"multiple": false,
|
|
737
|
+
"type": "option"
|
|
604
738
|
},
|
|
605
739
|
"visibility": {
|
|
606
|
-
"name": "visibility",
|
|
607
|
-
"type": "option",
|
|
608
740
|
"description": "visibility of domain in SwaggerHub",
|
|
741
|
+
"name": "visibility",
|
|
742
|
+
"hasDynamicHelp": false,
|
|
609
743
|
"multiple": false,
|
|
610
744
|
"options": [
|
|
611
745
|
"public",
|
|
612
746
|
"private"
|
|
613
|
-
]
|
|
747
|
+
],
|
|
748
|
+
"type": "option"
|
|
614
749
|
},
|
|
615
750
|
"published": {
|
|
616
|
-
"name": "published",
|
|
617
|
-
"type": "option",
|
|
618
751
|
"description": "sets the lifecycle setting of the domain version",
|
|
752
|
+
"name": "published",
|
|
619
753
|
"required": false,
|
|
754
|
+
"hasDynamicHelp": false,
|
|
620
755
|
"multiple": false,
|
|
621
756
|
"options": [
|
|
622
757
|
"publish",
|
|
623
758
|
"unpublish"
|
|
624
|
-
]
|
|
759
|
+
],
|
|
760
|
+
"type": "option"
|
|
625
761
|
},
|
|
626
762
|
"setdefault": {
|
|
627
|
-
"name": "setdefault",
|
|
628
|
-
"type": "boolean",
|
|
629
763
|
"description": "sets domain version to be the default",
|
|
764
|
+
"name": "setdefault",
|
|
630
765
|
"required": false,
|
|
631
|
-
"allowNo": false
|
|
766
|
+
"allowNo": false,
|
|
767
|
+
"type": "boolean"
|
|
768
|
+
},
|
|
769
|
+
"help": {
|
|
770
|
+
"char": "h",
|
|
771
|
+
"description": "Show CLI help.",
|
|
772
|
+
"name": "help",
|
|
773
|
+
"allowNo": false,
|
|
774
|
+
"type": "boolean"
|
|
632
775
|
}
|
|
633
776
|
},
|
|
777
|
+
"hasDynamicHelp": false,
|
|
778
|
+
"hiddenAliases": [],
|
|
779
|
+
"id": "domain:update",
|
|
780
|
+
"pluginAlias": "swaggerhub-cli",
|
|
781
|
+
"pluginName": "swaggerhub-cli",
|
|
782
|
+
"pluginType": "core",
|
|
783
|
+
"strict": true,
|
|
784
|
+
"isESM": false,
|
|
785
|
+
"relativePath": [
|
|
786
|
+
"src",
|
|
787
|
+
"commands",
|
|
788
|
+
"domain",
|
|
789
|
+
"update.js"
|
|
790
|
+
]
|
|
791
|
+
},
|
|
792
|
+
"integration:create": {
|
|
793
|
+
"aliases": [],
|
|
634
794
|
"args": {
|
|
635
|
-
"OWNER/
|
|
636
|
-
"
|
|
637
|
-
"
|
|
795
|
+
"OWNER/API_NAME/[VERSION]": {
|
|
796
|
+
"description": "API to add integration to on SwaggerHub",
|
|
797
|
+
"name": "OWNER/API_NAME/[VERSION]",
|
|
638
798
|
"required": true
|
|
639
799
|
}
|
|
640
|
-
}
|
|
641
|
-
},
|
|
642
|
-
"integration:create": {
|
|
643
|
-
"id": "integration:create",
|
|
800
|
+
},
|
|
644
801
|
"description": "creates a new API integration from a JSON configuration file.\nSee the documentation for configuration files: https://github.com/SmartBear/swaggerhub-cli/tree/main/examples/integrations\nWhen VERSION is not included in the argument, the integration will be added to be default API version.\n",
|
|
645
|
-
"strict": true,
|
|
646
|
-
"pluginName": "swaggerhub-cli",
|
|
647
|
-
"pluginAlias": "swaggerhub-cli",
|
|
648
|
-
"pluginType": "core",
|
|
649
|
-
"aliases": [],
|
|
650
802
|
"examples": [
|
|
651
803
|
"swaggerhub integration:create organization/api/1.0.0 --file config.json"
|
|
652
804
|
],
|
|
653
805
|
"flags": {
|
|
654
|
-
"help": {
|
|
655
|
-
"name": "help",
|
|
656
|
-
"type": "boolean",
|
|
657
|
-
"char": "h",
|
|
658
|
-
"description": "Show CLI help.",
|
|
659
|
-
"allowNo": false
|
|
660
|
-
},
|
|
661
806
|
"file": {
|
|
662
|
-
"name": "file",
|
|
663
|
-
"type": "option",
|
|
664
807
|
"char": "f",
|
|
665
808
|
"description": "location of integration configuration file",
|
|
809
|
+
"name": "file",
|
|
666
810
|
"required": true,
|
|
667
|
-
"
|
|
811
|
+
"hasDynamicHelp": false,
|
|
812
|
+
"multiple": false,
|
|
813
|
+
"type": "option"
|
|
814
|
+
},
|
|
815
|
+
"help": {
|
|
816
|
+
"char": "h",
|
|
817
|
+
"description": "Show CLI help.",
|
|
818
|
+
"name": "help",
|
|
819
|
+
"allowNo": false,
|
|
820
|
+
"type": "boolean"
|
|
668
821
|
}
|
|
669
822
|
},
|
|
823
|
+
"hasDynamicHelp": false,
|
|
824
|
+
"hiddenAliases": [],
|
|
825
|
+
"id": "integration:create",
|
|
826
|
+
"pluginAlias": "swaggerhub-cli",
|
|
827
|
+
"pluginName": "swaggerhub-cli",
|
|
828
|
+
"pluginType": "core",
|
|
829
|
+
"strict": true,
|
|
830
|
+
"enableJsonFlag": false,
|
|
831
|
+
"isESM": false,
|
|
832
|
+
"relativePath": [
|
|
833
|
+
"src",
|
|
834
|
+
"commands",
|
|
835
|
+
"integration",
|
|
836
|
+
"create.js"
|
|
837
|
+
]
|
|
838
|
+
},
|
|
839
|
+
"integration:delete": {
|
|
840
|
+
"aliases": [],
|
|
670
841
|
"args": {
|
|
671
|
-
"OWNER/API_NAME/
|
|
672
|
-
"
|
|
673
|
-
"
|
|
842
|
+
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
843
|
+
"description": "Integration to delete for given API on Swaggerhub",
|
|
844
|
+
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
674
845
|
"required": true
|
|
675
846
|
}
|
|
676
|
-
}
|
|
677
|
-
},
|
|
678
|
-
"integration:delete": {
|
|
679
|
-
"id": "integration:delete",
|
|
847
|
+
},
|
|
680
848
|
"description": "deletes the integration from the given API.",
|
|
681
|
-
"strict": true,
|
|
682
|
-
"pluginName": "swaggerhub-cli",
|
|
683
|
-
"pluginAlias": "swaggerhub-cli",
|
|
684
|
-
"pluginType": "core",
|
|
685
|
-
"aliases": [],
|
|
686
849
|
"examples": [
|
|
687
850
|
"swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704"
|
|
688
851
|
],
|
|
689
852
|
"flags": {
|
|
690
853
|
"help": {
|
|
691
|
-
"name": "help",
|
|
692
|
-
"type": "boolean",
|
|
693
854
|
"char": "h",
|
|
694
855
|
"description": "Show CLI help.",
|
|
695
|
-
"
|
|
856
|
+
"name": "help",
|
|
857
|
+
"allowNo": false,
|
|
858
|
+
"type": "boolean"
|
|
696
859
|
}
|
|
697
860
|
},
|
|
861
|
+
"hasDynamicHelp": false,
|
|
862
|
+
"hiddenAliases": [],
|
|
863
|
+
"id": "integration:delete",
|
|
864
|
+
"pluginAlias": "swaggerhub-cli",
|
|
865
|
+
"pluginName": "swaggerhub-cli",
|
|
866
|
+
"pluginType": "core",
|
|
867
|
+
"strict": true,
|
|
868
|
+
"enableJsonFlag": false,
|
|
869
|
+
"isESM": false,
|
|
870
|
+
"relativePath": [
|
|
871
|
+
"src",
|
|
872
|
+
"commands",
|
|
873
|
+
"integration",
|
|
874
|
+
"delete.js"
|
|
875
|
+
]
|
|
876
|
+
},
|
|
877
|
+
"integration:execute": {
|
|
878
|
+
"aliases": [],
|
|
698
879
|
"args": {
|
|
699
880
|
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
881
|
+
"description": "Integration to execute for given API on Swaggerhub",
|
|
700
882
|
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
701
|
-
"description": "Integration to delete for given API on Swaggerhub",
|
|
702
883
|
"required": true
|
|
703
884
|
}
|
|
704
|
-
}
|
|
705
|
-
},
|
|
706
|
-
"integration:execute": {
|
|
707
|
-
"id": "integration:execute",
|
|
885
|
+
},
|
|
708
886
|
"description": "executes an integration for the given API.",
|
|
709
|
-
"strict": true,
|
|
710
|
-
"pluginName": "swaggerhub-cli",
|
|
711
|
-
"pluginAlias": "swaggerhub-cli",
|
|
712
|
-
"pluginType": "core",
|
|
713
|
-
"aliases": [],
|
|
714
887
|
"examples": [
|
|
715
888
|
"swaggerhub integration:execute organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704"
|
|
716
889
|
],
|
|
717
890
|
"flags": {
|
|
718
891
|
"help": {
|
|
719
|
-
"name": "help",
|
|
720
|
-
"type": "boolean",
|
|
721
892
|
"char": "h",
|
|
722
893
|
"description": "Show CLI help.",
|
|
723
|
-
"
|
|
894
|
+
"name": "help",
|
|
895
|
+
"allowNo": false,
|
|
896
|
+
"type": "boolean"
|
|
724
897
|
}
|
|
725
898
|
},
|
|
899
|
+
"hasDynamicHelp": false,
|
|
900
|
+
"hiddenAliases": [],
|
|
901
|
+
"id": "integration:execute",
|
|
902
|
+
"pluginAlias": "swaggerhub-cli",
|
|
903
|
+
"pluginName": "swaggerhub-cli",
|
|
904
|
+
"pluginType": "core",
|
|
905
|
+
"strict": true,
|
|
906
|
+
"enableJsonFlag": false,
|
|
907
|
+
"isESM": false,
|
|
908
|
+
"relativePath": [
|
|
909
|
+
"src",
|
|
910
|
+
"commands",
|
|
911
|
+
"integration",
|
|
912
|
+
"execute.js"
|
|
913
|
+
]
|
|
914
|
+
},
|
|
915
|
+
"integration:get": {
|
|
916
|
+
"aliases": [],
|
|
726
917
|
"args": {
|
|
727
918
|
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
919
|
+
"description": "Integration to fetch for given API on Swaggerhub",
|
|
728
920
|
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
729
|
-
"description": "Integration to execute for given API on Swaggerhub",
|
|
730
921
|
"required": true
|
|
731
922
|
}
|
|
732
|
-
}
|
|
733
|
-
},
|
|
734
|
-
"integration:get": {
|
|
735
|
-
"id": "integration:get",
|
|
923
|
+
},
|
|
736
924
|
"description": "retieves an integration for the given API.",
|
|
737
|
-
"strict": true,
|
|
738
|
-
"pluginName": "swaggerhub-cli",
|
|
739
|
-
"pluginAlias": "swaggerhub-cli",
|
|
740
|
-
"pluginType": "core",
|
|
741
|
-
"aliases": [],
|
|
742
925
|
"examples": [
|
|
743
926
|
"swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704"
|
|
744
927
|
],
|
|
745
928
|
"flags": {
|
|
746
929
|
"help": {
|
|
747
|
-
"name": "help",
|
|
748
|
-
"type": "boolean",
|
|
749
930
|
"char": "h",
|
|
750
931
|
"description": "Show CLI help.",
|
|
751
|
-
"
|
|
932
|
+
"name": "help",
|
|
933
|
+
"allowNo": false,
|
|
934
|
+
"type": "boolean"
|
|
752
935
|
}
|
|
753
936
|
},
|
|
937
|
+
"hasDynamicHelp": false,
|
|
938
|
+
"hiddenAliases": [],
|
|
939
|
+
"id": "integration:get",
|
|
940
|
+
"pluginAlias": "swaggerhub-cli",
|
|
941
|
+
"pluginName": "swaggerhub-cli",
|
|
942
|
+
"pluginType": "core",
|
|
943
|
+
"strict": true,
|
|
944
|
+
"enableJsonFlag": false,
|
|
945
|
+
"isESM": false,
|
|
946
|
+
"relativePath": [
|
|
947
|
+
"src",
|
|
948
|
+
"commands",
|
|
949
|
+
"integration",
|
|
950
|
+
"get.js"
|
|
951
|
+
]
|
|
952
|
+
},
|
|
953
|
+
"integration:list": {
|
|
954
|
+
"aliases": [],
|
|
754
955
|
"args": {
|
|
755
|
-
"OWNER/API_NAME/VERSION
|
|
756
|
-
"
|
|
757
|
-
"
|
|
956
|
+
"OWNER/API_NAME/[VERSION]": {
|
|
957
|
+
"description": "API to list integrations for on Swaggerhub",
|
|
958
|
+
"name": "OWNER/API_NAME/[VERSION]",
|
|
758
959
|
"required": true
|
|
759
960
|
}
|
|
760
|
-
}
|
|
761
|
-
},
|
|
762
|
-
"integration:list": {
|
|
763
|
-
"id": "integration:list",
|
|
961
|
+
},
|
|
764
962
|
"description": "list integrations on an API.",
|
|
765
|
-
"strict": true,
|
|
766
|
-
"pluginName": "swaggerhub-cli",
|
|
767
|
-
"pluginAlias": "swaggerhub-cli",
|
|
768
|
-
"pluginType": "core",
|
|
769
|
-
"aliases": [],
|
|
770
963
|
"examples": [
|
|
771
964
|
"swaggerhub integration:list organization/api/1.0.0"
|
|
772
965
|
],
|
|
773
966
|
"flags": {
|
|
774
967
|
"help": {
|
|
775
|
-
"name": "help",
|
|
776
|
-
"type": "boolean",
|
|
777
968
|
"char": "h",
|
|
778
969
|
"description": "Show CLI help.",
|
|
779
|
-
"
|
|
970
|
+
"name": "help",
|
|
971
|
+
"allowNo": false,
|
|
972
|
+
"type": "boolean"
|
|
780
973
|
}
|
|
781
974
|
},
|
|
975
|
+
"hasDynamicHelp": false,
|
|
976
|
+
"hiddenAliases": [],
|
|
977
|
+
"id": "integration:list",
|
|
978
|
+
"pluginAlias": "swaggerhub-cli",
|
|
979
|
+
"pluginName": "swaggerhub-cli",
|
|
980
|
+
"pluginType": "core",
|
|
981
|
+
"strict": true,
|
|
982
|
+
"enableJsonFlag": false,
|
|
983
|
+
"isESM": false,
|
|
984
|
+
"relativePath": [
|
|
985
|
+
"src",
|
|
986
|
+
"commands",
|
|
987
|
+
"integration",
|
|
988
|
+
"list.js"
|
|
989
|
+
]
|
|
990
|
+
},
|
|
991
|
+
"integration:update": {
|
|
992
|
+
"aliases": [],
|
|
782
993
|
"args": {
|
|
783
|
-
"OWNER/API_NAME/
|
|
784
|
-
"
|
|
785
|
-
"
|
|
994
|
+
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
995
|
+
"description": "Integration to update for given API on Swaggerhub",
|
|
996
|
+
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
786
997
|
"required": true
|
|
787
998
|
}
|
|
788
|
-
}
|
|
789
|
-
},
|
|
790
|
-
"integration:update": {
|
|
791
|
-
"id": "integration:update",
|
|
999
|
+
},
|
|
792
1000
|
"description": "update the configuration of an API integration.",
|
|
793
|
-
"strict": true,
|
|
794
|
-
"pluginName": "swaggerhub-cli",
|
|
795
|
-
"pluginAlias": "swaggerhub-cli",
|
|
796
|
-
"pluginType": "core",
|
|
797
|
-
"aliases": [],
|
|
798
1001
|
"examples": [
|
|
799
1002
|
"swaggerhub integration:update organization/api/1.0.0/503c2db6-448a-4678-abcd-0123456789abc --file config.json"
|
|
800
1003
|
],
|
|
801
1004
|
"flags": {
|
|
802
|
-
"help": {
|
|
803
|
-
"name": "help",
|
|
804
|
-
"type": "boolean",
|
|
805
|
-
"char": "h",
|
|
806
|
-
"description": "Show CLI help.",
|
|
807
|
-
"allowNo": false
|
|
808
|
-
},
|
|
809
1005
|
"file": {
|
|
810
|
-
"name": "file",
|
|
811
|
-
"type": "option",
|
|
812
1006
|
"char": "f",
|
|
813
1007
|
"description": "location of integration configuration file",
|
|
1008
|
+
"name": "file",
|
|
814
1009
|
"required": true,
|
|
815
|
-
"
|
|
1010
|
+
"hasDynamicHelp": false,
|
|
1011
|
+
"multiple": false,
|
|
1012
|
+
"type": "option"
|
|
1013
|
+
},
|
|
1014
|
+
"help": {
|
|
1015
|
+
"char": "h",
|
|
1016
|
+
"description": "Show CLI help.",
|
|
1017
|
+
"name": "help",
|
|
1018
|
+
"allowNo": false,
|
|
1019
|
+
"type": "boolean"
|
|
816
1020
|
}
|
|
817
1021
|
},
|
|
1022
|
+
"hasDynamicHelp": false,
|
|
1023
|
+
"hiddenAliases": [],
|
|
1024
|
+
"id": "integration:update",
|
|
1025
|
+
"pluginAlias": "swaggerhub-cli",
|
|
1026
|
+
"pluginName": "swaggerhub-cli",
|
|
1027
|
+
"pluginType": "core",
|
|
1028
|
+
"strict": true,
|
|
1029
|
+
"enableJsonFlag": false,
|
|
1030
|
+
"isESM": false,
|
|
1031
|
+
"relativePath": [
|
|
1032
|
+
"src",
|
|
1033
|
+
"commands",
|
|
1034
|
+
"integration",
|
|
1035
|
+
"update.js"
|
|
1036
|
+
]
|
|
1037
|
+
},
|
|
1038
|
+
"project:create": {
|
|
1039
|
+
"aliases": [],
|
|
818
1040
|
"args": {
|
|
819
|
-
"OWNER/
|
|
820
|
-
"
|
|
821
|
-
"
|
|
1041
|
+
"OWNER/PROJECT_NAME": {
|
|
1042
|
+
"description": "The new project to create on Swaggerhub",
|
|
1043
|
+
"name": "OWNER/PROJECT_NAME",
|
|
822
1044
|
"required": true
|
|
823
1045
|
}
|
|
824
|
-
}
|
|
825
|
-
},
|
|
826
|
-
"project:create": {
|
|
827
|
-
"id": "project:create",
|
|
1046
|
+
},
|
|
828
1047
|
"description": "Creates a new project in SwaggerHub.",
|
|
829
|
-
"strict": true,
|
|
830
|
-
"pluginName": "swaggerhub-cli",
|
|
831
|
-
"pluginAlias": "swaggerhub-cli",
|
|
832
|
-
"pluginType": "core",
|
|
833
|
-
"aliases": [],
|
|
834
1048
|
"examples": [
|
|
835
1049
|
"swaggerhub project:create organization/new_project_name --description \"project description\"",
|
|
836
1050
|
"swaggerhub project:create organization/new_project_name -a \"testapi1,testapi2\"",
|
|
@@ -840,386 +1054,563 @@
|
|
|
840
1054
|
"swaggerhub project:create organization/new_project_name -a \"testapi1\" -d \"testdomain3\" --description \"description\""
|
|
841
1055
|
],
|
|
842
1056
|
"flags": {
|
|
843
|
-
"help": {
|
|
844
|
-
"name": "help",
|
|
845
|
-
"type": "boolean",
|
|
846
|
-
"char": "h",
|
|
847
|
-
"description": "Show CLI help.",
|
|
848
|
-
"allowNo": false
|
|
849
|
-
},
|
|
850
1057
|
"description": {
|
|
851
|
-
"name": "description",
|
|
852
|
-
"type": "option",
|
|
853
1058
|
"description": "Description of project",
|
|
1059
|
+
"name": "description",
|
|
854
1060
|
"required": false,
|
|
855
|
-
"
|
|
1061
|
+
"hasDynamicHelp": false,
|
|
1062
|
+
"multiple": false,
|
|
1063
|
+
"type": "option"
|
|
856
1064
|
},
|
|
857
1065
|
"apis": {
|
|
858
|
-
"name": "apis",
|
|
859
|
-
"type": "option",
|
|
860
1066
|
"char": "a",
|
|
861
1067
|
"description": "Comma separated list of api names to include in project",
|
|
1068
|
+
"name": "apis",
|
|
862
1069
|
"required": false,
|
|
863
|
-
"
|
|
1070
|
+
"hasDynamicHelp": false,
|
|
1071
|
+
"multiple": false,
|
|
1072
|
+
"type": "option"
|
|
864
1073
|
},
|
|
865
1074
|
"domains": {
|
|
866
|
-
"name": "domains",
|
|
867
|
-
"type": "option",
|
|
868
1075
|
"char": "d",
|
|
869
1076
|
"description": "Comma separated list of domain names to include in project",
|
|
1077
|
+
"name": "domains",
|
|
870
1078
|
"required": false,
|
|
871
|
-
"
|
|
1079
|
+
"hasDynamicHelp": false,
|
|
1080
|
+
"multiple": false,
|
|
1081
|
+
"type": "option"
|
|
1082
|
+
},
|
|
1083
|
+
"help": {
|
|
1084
|
+
"char": "h",
|
|
1085
|
+
"description": "Show CLI help.",
|
|
1086
|
+
"name": "help",
|
|
1087
|
+
"allowNo": false,
|
|
1088
|
+
"type": "boolean"
|
|
872
1089
|
}
|
|
873
1090
|
},
|
|
1091
|
+
"hasDynamicHelp": false,
|
|
1092
|
+
"hiddenAliases": [],
|
|
1093
|
+
"id": "project:create",
|
|
1094
|
+
"pluginAlias": "swaggerhub-cli",
|
|
1095
|
+
"pluginName": "swaggerhub-cli",
|
|
1096
|
+
"pluginType": "core",
|
|
1097
|
+
"strict": true,
|
|
1098
|
+
"enableJsonFlag": false,
|
|
1099
|
+
"isESM": false,
|
|
1100
|
+
"relativePath": [
|
|
1101
|
+
"src",
|
|
1102
|
+
"commands",
|
|
1103
|
+
"project",
|
|
1104
|
+
"create.js"
|
|
1105
|
+
]
|
|
1106
|
+
},
|
|
1107
|
+
"project:delete": {
|
|
1108
|
+
"aliases": [],
|
|
874
1109
|
"args": {
|
|
875
1110
|
"OWNER/PROJECT_NAME": {
|
|
1111
|
+
"description": "The project to delete on Swaggerhub",
|
|
876
1112
|
"name": "OWNER/PROJECT_NAME",
|
|
877
|
-
"description": "The new project to create on Swaggerhub",
|
|
878
1113
|
"required": true
|
|
879
1114
|
}
|
|
880
|
-
}
|
|
881
|
-
},
|
|
882
|
-
"project:delete": {
|
|
883
|
-
"id": "project:delete",
|
|
1115
|
+
},
|
|
884
1116
|
"description": "Deletes a project from SwaggerHub.",
|
|
885
|
-
"strict": true,
|
|
886
|
-
"pluginName": "swaggerhub-cli",
|
|
887
|
-
"pluginAlias": "swaggerhub-cli",
|
|
888
|
-
"pluginType": "core",
|
|
889
|
-
"aliases": [],
|
|
890
1117
|
"examples": [
|
|
891
1118
|
"swaggerhub project:delete organization/project_name"
|
|
892
1119
|
],
|
|
893
1120
|
"flags": {
|
|
894
1121
|
"help": {
|
|
895
|
-
"name": "help",
|
|
896
|
-
"type": "boolean",
|
|
897
1122
|
"char": "h",
|
|
898
1123
|
"description": "Show CLI help.",
|
|
899
|
-
"
|
|
1124
|
+
"name": "help",
|
|
1125
|
+
"allowNo": false,
|
|
1126
|
+
"type": "boolean"
|
|
900
1127
|
}
|
|
901
1128
|
},
|
|
1129
|
+
"hasDynamicHelp": false,
|
|
1130
|
+
"hiddenAliases": [],
|
|
1131
|
+
"id": "project:delete",
|
|
1132
|
+
"pluginAlias": "swaggerhub-cli",
|
|
1133
|
+
"pluginName": "swaggerhub-cli",
|
|
1134
|
+
"pluginType": "core",
|
|
1135
|
+
"strict": true,
|
|
1136
|
+
"enableJsonFlag": false,
|
|
1137
|
+
"isESM": false,
|
|
1138
|
+
"relativePath": [
|
|
1139
|
+
"src",
|
|
1140
|
+
"commands",
|
|
1141
|
+
"project",
|
|
1142
|
+
"delete.js"
|
|
1143
|
+
]
|
|
1144
|
+
},
|
|
1145
|
+
"project:get": {
|
|
1146
|
+
"aliases": [],
|
|
902
1147
|
"args": {
|
|
903
1148
|
"OWNER/PROJECT_NAME": {
|
|
1149
|
+
"description": "The project to get details for on Swaggerhub",
|
|
904
1150
|
"name": "OWNER/PROJECT_NAME",
|
|
905
|
-
"description": "The project to delete on Swaggerhub",
|
|
906
1151
|
"required": true
|
|
907
1152
|
}
|
|
908
|
-
}
|
|
909
|
-
},
|
|
910
|
-
"project:get": {
|
|
911
|
-
"id": "project:get",
|
|
1153
|
+
},
|
|
912
1154
|
"description": "Retrieves the details for a project.",
|
|
913
|
-
"strict": true,
|
|
914
|
-
"pluginName": "swaggerhub-cli",
|
|
915
|
-
"pluginAlias": "swaggerhub-cli",
|
|
916
|
-
"pluginType": "core",
|
|
917
|
-
"aliases": [],
|
|
918
1155
|
"examples": [
|
|
919
1156
|
"swaggerhub project:get organization/project_name"
|
|
920
1157
|
],
|
|
921
1158
|
"flags": {
|
|
922
1159
|
"help": {
|
|
923
|
-
"name": "help",
|
|
924
|
-
"type": "boolean",
|
|
925
1160
|
"char": "h",
|
|
926
1161
|
"description": "Show CLI help.",
|
|
927
|
-
"
|
|
1162
|
+
"name": "help",
|
|
1163
|
+
"allowNo": false,
|
|
1164
|
+
"type": "boolean"
|
|
928
1165
|
}
|
|
929
1166
|
},
|
|
930
|
-
"
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
"description": "The project to get details for on Swaggerhub",
|
|
934
|
-
"required": true
|
|
935
|
-
}
|
|
936
|
-
}
|
|
937
|
-
},
|
|
938
|
-
"project:list": {
|
|
939
|
-
"id": "project:list",
|
|
940
|
-
"description": "list projects",
|
|
941
|
-
"strict": true,
|
|
942
|
-
"pluginName": "swaggerhub-cli",
|
|
1167
|
+
"hasDynamicHelp": false,
|
|
1168
|
+
"hiddenAliases": [],
|
|
1169
|
+
"id": "project:get",
|
|
943
1170
|
"pluginAlias": "swaggerhub-cli",
|
|
1171
|
+
"pluginName": "swaggerhub-cli",
|
|
944
1172
|
"pluginType": "core",
|
|
1173
|
+
"strict": true,
|
|
1174
|
+
"enableJsonFlag": false,
|
|
1175
|
+
"isESM": false,
|
|
1176
|
+
"relativePath": [
|
|
1177
|
+
"src",
|
|
1178
|
+
"commands",
|
|
1179
|
+
"project",
|
|
1180
|
+
"get.js"
|
|
1181
|
+
]
|
|
1182
|
+
},
|
|
1183
|
+
"project:list": {
|
|
945
1184
|
"aliases": [],
|
|
946
|
-
"
|
|
947
|
-
"
|
|
948
|
-
|
|
949
|
-
|
|
1185
|
+
"args": {
|
|
1186
|
+
"OWNER": {
|
|
1187
|
+
"description": "The organization to list projects for on Swaggerhub",
|
|
1188
|
+
"name": "OWNER",
|
|
1189
|
+
"required": false
|
|
1190
|
+
}
|
|
1191
|
+
},
|
|
1192
|
+
"description": "list projects",
|
|
1193
|
+
"examples": [
|
|
1194
|
+
"swaggerhub project:list",
|
|
1195
|
+
"swaggerhub project:list organization"
|
|
1196
|
+
],
|
|
950
1197
|
"flags": {
|
|
951
1198
|
"help": {
|
|
952
|
-
"name": "help",
|
|
953
|
-
"type": "boolean",
|
|
954
1199
|
"char": "h",
|
|
955
1200
|
"description": "Show CLI help.",
|
|
956
|
-
"
|
|
1201
|
+
"name": "help",
|
|
1202
|
+
"allowNo": false,
|
|
1203
|
+
"type": "boolean"
|
|
957
1204
|
}
|
|
958
1205
|
},
|
|
1206
|
+
"hasDynamicHelp": false,
|
|
1207
|
+
"hiddenAliases": [],
|
|
1208
|
+
"id": "project:list",
|
|
1209
|
+
"pluginAlias": "swaggerhub-cli",
|
|
1210
|
+
"pluginName": "swaggerhub-cli",
|
|
1211
|
+
"pluginType": "core",
|
|
1212
|
+
"strict": true,
|
|
1213
|
+
"enableJsonFlag": false,
|
|
1214
|
+
"isESM": false,
|
|
1215
|
+
"relativePath": [
|
|
1216
|
+
"src",
|
|
1217
|
+
"commands",
|
|
1218
|
+
"project",
|
|
1219
|
+
"list.js"
|
|
1220
|
+
]
|
|
1221
|
+
},
|
|
1222
|
+
"api:validate:download-rules": {
|
|
1223
|
+
"aliases": [],
|
|
959
1224
|
"args": {
|
|
960
1225
|
"OWNER": {
|
|
1226
|
+
"description": "Which organization standardization rules to fetch from SwaggerHub",
|
|
961
1227
|
"name": "OWNER",
|
|
962
|
-
"
|
|
963
|
-
"required": false
|
|
1228
|
+
"required": true
|
|
964
1229
|
}
|
|
965
|
-
}
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
"
|
|
1230
|
+
},
|
|
1231
|
+
"description": "Get existing SwaggerHub's organization standardization ruleset.\nRequires organization name argument. An error will occur if provided organization doesn't exist\nor your account is not permitted to access that organization's settings.\nIf the flag `-s` or `--include-system-rules` is used, the returned ruleset will also include SwaggerHub system rules.\nIf the flag `-d` or `--include-disabled-rules` is used, the returned ruleset will also include disabled custom rules",
|
|
1232
|
+
"examples": [
|
|
1233
|
+
"swaggerhub api:validate:download-rules myOrg -s",
|
|
1234
|
+
"swaggerhub api:validate:download-rules myOrg --include-disabled-rules -s"
|
|
1235
|
+
],
|
|
1236
|
+
"flags": {
|
|
1237
|
+
"include-system-rules": {
|
|
1238
|
+
"char": "s",
|
|
1239
|
+
"description": "Includes system rules in fetched organization's ruleset",
|
|
1240
|
+
"name": "include-system-rules",
|
|
1241
|
+
"required": false,
|
|
1242
|
+
"allowNo": false,
|
|
1243
|
+
"type": "boolean"
|
|
1244
|
+
},
|
|
1245
|
+
"include-disabled-rules": {
|
|
1246
|
+
"char": "d",
|
|
1247
|
+
"description": "Includes disabled rules in fetched organization's ruleset",
|
|
1248
|
+
"name": "include-disabled-rules",
|
|
1249
|
+
"required": false,
|
|
1250
|
+
"allowNo": false,
|
|
1251
|
+
"type": "boolean"
|
|
1252
|
+
},
|
|
1253
|
+
"help": {
|
|
1254
|
+
"char": "h",
|
|
1255
|
+
"description": "Show CLI help.",
|
|
1256
|
+
"name": "help",
|
|
1257
|
+
"allowNo": false,
|
|
1258
|
+
"type": "boolean"
|
|
1259
|
+
}
|
|
1260
|
+
},
|
|
1261
|
+
"hasDynamicHelp": false,
|
|
1262
|
+
"hiddenAliases": [],
|
|
1263
|
+
"id": "api:validate:download-rules",
|
|
972
1264
|
"pluginAlias": "swaggerhub-cli",
|
|
1265
|
+
"pluginName": "swaggerhub-cli",
|
|
973
1266
|
"pluginType": "core",
|
|
1267
|
+
"strict": true,
|
|
1268
|
+
"enableJsonFlag": false,
|
|
1269
|
+
"isESM": false,
|
|
1270
|
+
"relativePath": [
|
|
1271
|
+
"src",
|
|
1272
|
+
"commands",
|
|
1273
|
+
"api",
|
|
1274
|
+
"validate",
|
|
1275
|
+
"download-rules.js"
|
|
1276
|
+
]
|
|
1277
|
+
},
|
|
1278
|
+
"api:validate": {
|
|
974
1279
|
"aliases": [],
|
|
1280
|
+
"args": {
|
|
1281
|
+
"OWNER/API_NAME/[VERSION]": {
|
|
1282
|
+
"description": "API to fetch validation errors for from Swaggerhub",
|
|
1283
|
+
"name": "OWNER/API_NAME/[VERSION]",
|
|
1284
|
+
"required": true
|
|
1285
|
+
}
|
|
1286
|
+
},
|
|
1287
|
+
"description": "Get validation result for an API version\nWhen VERSION is not included in the argument, the default version will be validated.\nAn error will occur if the API version does not exist.\nIf the flag `-c` or `--failOnCritical` is used and there are standardization\nerrors with `Critical` severity present, the command will exit with error code `1`.\n",
|
|
975
1288
|
"examples": [
|
|
976
1289
|
"swaggerhub api:validate organization/api/1.0.0",
|
|
977
1290
|
"swaggerhub api:validate -c -j organization/api/1.0.0",
|
|
978
1291
|
"swaggerhub api:validate --fail-on-critical --json organization/api"
|
|
979
1292
|
],
|
|
980
1293
|
"flags": {
|
|
981
|
-
"help": {
|
|
982
|
-
"name": "help",
|
|
983
|
-
"type": "boolean",
|
|
984
|
-
"char": "h",
|
|
985
|
-
"description": "Show CLI help.",
|
|
986
|
-
"allowNo": false
|
|
987
|
-
},
|
|
988
1294
|
"fail-on-critical": {
|
|
989
|
-
"name": "fail-on-critical",
|
|
990
|
-
"type": "boolean",
|
|
991
1295
|
"char": "c",
|
|
992
1296
|
"description": "Exit with error code 1 if there are critical standardization errors present",
|
|
993
|
-
"
|
|
1297
|
+
"name": "fail-on-critical",
|
|
1298
|
+
"allowNo": false,
|
|
1299
|
+
"type": "boolean"
|
|
994
1300
|
},
|
|
995
1301
|
"json": {
|
|
996
|
-
"name": "json",
|
|
997
|
-
"type": "boolean",
|
|
998
1302
|
"char": "j",
|
|
999
1303
|
"description": "Print output in JSON instead of table format",
|
|
1000
|
-
"
|
|
1304
|
+
"name": "json",
|
|
1305
|
+
"allowNo": false,
|
|
1306
|
+
"type": "boolean"
|
|
1307
|
+
},
|
|
1308
|
+
"help": {
|
|
1309
|
+
"char": "h",
|
|
1310
|
+
"description": "Show CLI help.",
|
|
1311
|
+
"name": "help",
|
|
1312
|
+
"allowNo": false,
|
|
1313
|
+
"type": "boolean"
|
|
1001
1314
|
}
|
|
1002
1315
|
},
|
|
1003
|
-
"
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
"description": "API to fetch validation errors for from Swaggerhub",
|
|
1007
|
-
"required": true
|
|
1008
|
-
}
|
|
1009
|
-
}
|
|
1010
|
-
},
|
|
1011
|
-
"api:validate:local": {
|
|
1012
|
-
"id": "api:validate:local",
|
|
1013
|
-
"description": "Runs a scan against a local API definition using the organization's standardization configuration on SwaggerHub.\nIf the flag `-c` or `--failOnCritical` is used and there are standardization\nerrors with `Critical` severity present, the command will exit with error code `1`.\n",
|
|
1014
|
-
"strict": true,
|
|
1015
|
-
"pluginName": "swaggerhub-cli",
|
|
1316
|
+
"hasDynamicHelp": false,
|
|
1317
|
+
"hiddenAliases": [],
|
|
1318
|
+
"id": "api:validate",
|
|
1016
1319
|
"pluginAlias": "swaggerhub-cli",
|
|
1320
|
+
"pluginName": "swaggerhub-cli",
|
|
1017
1321
|
"pluginType": "core",
|
|
1322
|
+
"strict": true,
|
|
1323
|
+
"enableJsonFlag": false,
|
|
1324
|
+
"isESM": false,
|
|
1325
|
+
"relativePath": [
|
|
1326
|
+
"src",
|
|
1327
|
+
"commands",
|
|
1328
|
+
"api",
|
|
1329
|
+
"validate",
|
|
1330
|
+
"index.js"
|
|
1331
|
+
]
|
|
1332
|
+
},
|
|
1333
|
+
"api:validate:local": {
|
|
1018
1334
|
"aliases": [],
|
|
1335
|
+
"args": {},
|
|
1336
|
+
"description": "Runs a scan against a local API definition using the organization's standardization configuration on SwaggerHub.\nIf the flag `-c` or `--failOnCritical` is used and there are standardization\nerrors with `Critical` severity present, the command will exit with error code `1`.\n",
|
|
1019
1337
|
"examples": [
|
|
1020
1338
|
"swaggerhub api:validate:local -o myOrg -f ./my-api.yaml -c -j ",
|
|
1021
1339
|
"swaggerhub api:validate:local --organization myOrg --file ./my-api/json --fail-on-critical --json"
|
|
1022
1340
|
],
|
|
1023
1341
|
"flags": {
|
|
1024
|
-
"help": {
|
|
1025
|
-
"name": "help",
|
|
1026
|
-
"type": "boolean",
|
|
1027
|
-
"char": "h",
|
|
1028
|
-
"description": "Show CLI help.",
|
|
1029
|
-
"allowNo": false
|
|
1030
|
-
},
|
|
1031
|
-
"fail-on-critical": {
|
|
1032
|
-
"name": "fail-on-critical",
|
|
1033
|
-
"type": "boolean",
|
|
1034
|
-
"char": "c",
|
|
1035
|
-
"description": "Exit with error code 1 if there are critical standardization errors present",
|
|
1036
|
-
"allowNo": false
|
|
1037
|
-
},
|
|
1038
|
-
"json": {
|
|
1039
|
-
"name": "json",
|
|
1040
|
-
"type": "boolean",
|
|
1041
|
-
"char": "j",
|
|
1042
|
-
"description": "Print output in JSON instead of table format",
|
|
1043
|
-
"allowNo": false
|
|
1044
|
-
},
|
|
1045
1342
|
"file": {
|
|
1046
|
-
"name": "file",
|
|
1047
|
-
"type": "option",
|
|
1048
1343
|
"char": "f",
|
|
1049
1344
|
"description": "Path of API definition file to run scan against",
|
|
1345
|
+
"name": "file",
|
|
1050
1346
|
"required": true,
|
|
1051
|
-
"
|
|
1347
|
+
"hasDynamicHelp": false,
|
|
1348
|
+
"multiple": false,
|
|
1349
|
+
"type": "option"
|
|
1052
1350
|
},
|
|
1053
1351
|
"organization": {
|
|
1054
|
-
"name": "organization",
|
|
1055
|
-
"type": "option",
|
|
1056
1352
|
"char": "o",
|
|
1057
1353
|
"description": "Which organization's standardization settings to use for linting the target definition",
|
|
1354
|
+
"name": "organization",
|
|
1058
1355
|
"required": true,
|
|
1059
|
-
"
|
|
1356
|
+
"hasDynamicHelp": false,
|
|
1357
|
+
"multiple": false,
|
|
1358
|
+
"type": "option"
|
|
1359
|
+
},
|
|
1360
|
+
"fail-on-critical": {
|
|
1361
|
+
"char": "c",
|
|
1362
|
+
"description": "Exit with error code 1 if there are critical standardization errors present",
|
|
1363
|
+
"name": "fail-on-critical",
|
|
1364
|
+
"allowNo": false,
|
|
1365
|
+
"type": "boolean"
|
|
1366
|
+
},
|
|
1367
|
+
"json": {
|
|
1368
|
+
"char": "j",
|
|
1369
|
+
"description": "Print output in JSON instead of table format",
|
|
1370
|
+
"name": "json",
|
|
1371
|
+
"allowNo": false,
|
|
1372
|
+
"type": "boolean"
|
|
1373
|
+
},
|
|
1374
|
+
"help": {
|
|
1375
|
+
"char": "h",
|
|
1376
|
+
"description": "Show CLI help.",
|
|
1377
|
+
"name": "help",
|
|
1378
|
+
"allowNo": false,
|
|
1379
|
+
"type": "boolean"
|
|
1060
1380
|
}
|
|
1061
1381
|
},
|
|
1062
|
-
"
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
"id": "project:api:add",
|
|
1066
|
-
"description": "Adds an API to an existing project.",
|
|
1067
|
-
"strict": true,
|
|
1068
|
-
"pluginName": "swaggerhub-cli",
|
|
1382
|
+
"hasDynamicHelp": false,
|
|
1383
|
+
"hiddenAliases": [],
|
|
1384
|
+
"id": "api:validate:local",
|
|
1069
1385
|
"pluginAlias": "swaggerhub-cli",
|
|
1386
|
+
"pluginName": "swaggerhub-cli",
|
|
1070
1387
|
"pluginType": "core",
|
|
1388
|
+
"strict": true,
|
|
1389
|
+
"enableJsonFlag": false,
|
|
1390
|
+
"isESM": false,
|
|
1391
|
+
"relativePath": [
|
|
1392
|
+
"src",
|
|
1393
|
+
"commands",
|
|
1394
|
+
"api",
|
|
1395
|
+
"validate",
|
|
1396
|
+
"local.js"
|
|
1397
|
+
]
|
|
1398
|
+
},
|
|
1399
|
+
"project:api:add": {
|
|
1071
1400
|
"aliases": [],
|
|
1401
|
+
"args": {
|
|
1402
|
+
"OWNER/PROJECT_NAME": {
|
|
1403
|
+
"description": "The project to add the API to on Swaggerhub",
|
|
1404
|
+
"name": "OWNER/PROJECT_NAME",
|
|
1405
|
+
"required": true
|
|
1406
|
+
},
|
|
1407
|
+
"API": {
|
|
1408
|
+
"description": "The name of the API on Swaggerhub to add",
|
|
1409
|
+
"name": "API",
|
|
1410
|
+
"required": true
|
|
1411
|
+
}
|
|
1412
|
+
},
|
|
1413
|
+
"description": "Adds an API to an existing project.",
|
|
1072
1414
|
"examples": [
|
|
1073
1415
|
"swaggerhub project:api:add organization/project_name my_api"
|
|
1074
1416
|
],
|
|
1075
1417
|
"flags": {
|
|
1076
1418
|
"help": {
|
|
1077
|
-
"name": "help",
|
|
1078
|
-
"type": "boolean",
|
|
1079
1419
|
"char": "h",
|
|
1080
1420
|
"description": "Show CLI help.",
|
|
1081
|
-
"
|
|
1421
|
+
"name": "help",
|
|
1422
|
+
"allowNo": false,
|
|
1423
|
+
"type": "boolean"
|
|
1082
1424
|
}
|
|
1083
1425
|
},
|
|
1426
|
+
"hasDynamicHelp": false,
|
|
1427
|
+
"hiddenAliases": [],
|
|
1428
|
+
"id": "project:api:add",
|
|
1429
|
+
"pluginAlias": "swaggerhub-cli",
|
|
1430
|
+
"pluginName": "swaggerhub-cli",
|
|
1431
|
+
"pluginType": "core",
|
|
1432
|
+
"strict": true,
|
|
1433
|
+
"enableJsonFlag": false,
|
|
1434
|
+
"isESM": false,
|
|
1435
|
+
"relativePath": [
|
|
1436
|
+
"src",
|
|
1437
|
+
"commands",
|
|
1438
|
+
"project",
|
|
1439
|
+
"api",
|
|
1440
|
+
"add.js"
|
|
1441
|
+
]
|
|
1442
|
+
},
|
|
1443
|
+
"project:api:remove": {
|
|
1444
|
+
"aliases": [],
|
|
1084
1445
|
"args": {
|
|
1085
1446
|
"OWNER/PROJECT_NAME": {
|
|
1447
|
+
"description": "The project to remove the API from on Swaggerhub",
|
|
1086
1448
|
"name": "OWNER/PROJECT_NAME",
|
|
1087
|
-
"description": "The project to add the API to on Swaggerhub",
|
|
1088
1449
|
"required": true
|
|
1089
1450
|
},
|
|
1090
1451
|
"API": {
|
|
1452
|
+
"description": "The name of the API on Swaggerhub to remove",
|
|
1091
1453
|
"name": "API",
|
|
1092
|
-
"description": "The name of the API on Swaggerhub to add",
|
|
1093
1454
|
"required": true
|
|
1094
1455
|
}
|
|
1095
|
-
}
|
|
1096
|
-
},
|
|
1097
|
-
"project:api:remove": {
|
|
1098
|
-
"id": "project:api:remove",
|
|
1456
|
+
},
|
|
1099
1457
|
"description": "Removes an API from a project in SwaggerHub.",
|
|
1100
|
-
"strict": true,
|
|
1101
|
-
"pluginName": "swaggerhub-cli",
|
|
1102
|
-
"pluginAlias": "swaggerhub-cli",
|
|
1103
|
-
"pluginType": "core",
|
|
1104
|
-
"aliases": [],
|
|
1105
1458
|
"examples": [
|
|
1106
1459
|
"swaggerhub project:api:remove organization/project_name my_api"
|
|
1107
1460
|
],
|
|
1108
1461
|
"flags": {
|
|
1109
1462
|
"help": {
|
|
1110
|
-
"name": "help",
|
|
1111
|
-
"type": "boolean",
|
|
1112
1463
|
"char": "h",
|
|
1113
1464
|
"description": "Show CLI help.",
|
|
1114
|
-
"
|
|
1465
|
+
"name": "help",
|
|
1466
|
+
"allowNo": false,
|
|
1467
|
+
"type": "boolean"
|
|
1115
1468
|
}
|
|
1116
1469
|
},
|
|
1470
|
+
"hasDynamicHelp": false,
|
|
1471
|
+
"hiddenAliases": [],
|
|
1472
|
+
"id": "project:api:remove",
|
|
1473
|
+
"pluginAlias": "swaggerhub-cli",
|
|
1474
|
+
"pluginName": "swaggerhub-cli",
|
|
1475
|
+
"pluginType": "core",
|
|
1476
|
+
"strict": true,
|
|
1477
|
+
"enableJsonFlag": false,
|
|
1478
|
+
"isESM": false,
|
|
1479
|
+
"relativePath": [
|
|
1480
|
+
"src",
|
|
1481
|
+
"commands",
|
|
1482
|
+
"project",
|
|
1483
|
+
"api",
|
|
1484
|
+
"remove.js"
|
|
1485
|
+
]
|
|
1486
|
+
},
|
|
1487
|
+
"project:domain:add": {
|
|
1488
|
+
"aliases": [],
|
|
1117
1489
|
"args": {
|
|
1118
1490
|
"OWNER/PROJECT_NAME": {
|
|
1491
|
+
"description": "The project to add the domain to on Swaggerhub",
|
|
1119
1492
|
"name": "OWNER/PROJECT_NAME",
|
|
1120
|
-
"description": "The project to remove the API from on Swaggerhub",
|
|
1121
1493
|
"required": true
|
|
1122
1494
|
},
|
|
1123
|
-
"
|
|
1124
|
-
"
|
|
1125
|
-
"
|
|
1495
|
+
"DOMAIN": {
|
|
1496
|
+
"description": "The name of the domain on Swaggerhub to add",
|
|
1497
|
+
"name": "DOMAIN",
|
|
1126
1498
|
"required": true
|
|
1127
1499
|
}
|
|
1128
|
-
}
|
|
1129
|
-
},
|
|
1130
|
-
"project:domain:add": {
|
|
1131
|
-
"id": "project:domain:add",
|
|
1500
|
+
},
|
|
1132
1501
|
"description": "Adds a domain to an existing project.",
|
|
1133
|
-
"strict": true,
|
|
1134
|
-
"pluginName": "swaggerhub-cli",
|
|
1135
|
-
"pluginAlias": "swaggerhub-cli",
|
|
1136
|
-
"pluginType": "core",
|
|
1137
|
-
"aliases": [],
|
|
1138
1502
|
"examples": [
|
|
1139
1503
|
"swaggerhub project:domain:add organization/project_name my_domain"
|
|
1140
1504
|
],
|
|
1141
1505
|
"flags": {
|
|
1142
1506
|
"help": {
|
|
1143
|
-
"name": "help",
|
|
1144
|
-
"type": "boolean",
|
|
1145
1507
|
"char": "h",
|
|
1146
1508
|
"description": "Show CLI help.",
|
|
1147
|
-
"
|
|
1509
|
+
"name": "help",
|
|
1510
|
+
"allowNo": false,
|
|
1511
|
+
"type": "boolean"
|
|
1148
1512
|
}
|
|
1149
1513
|
},
|
|
1514
|
+
"hasDynamicHelp": false,
|
|
1515
|
+
"hiddenAliases": [],
|
|
1516
|
+
"id": "project:domain:add",
|
|
1517
|
+
"pluginAlias": "swaggerhub-cli",
|
|
1518
|
+
"pluginName": "swaggerhub-cli",
|
|
1519
|
+
"pluginType": "core",
|
|
1520
|
+
"strict": true,
|
|
1521
|
+
"enableJsonFlag": false,
|
|
1522
|
+
"isESM": false,
|
|
1523
|
+
"relativePath": [
|
|
1524
|
+
"src",
|
|
1525
|
+
"commands",
|
|
1526
|
+
"project",
|
|
1527
|
+
"domain",
|
|
1528
|
+
"add.js"
|
|
1529
|
+
]
|
|
1530
|
+
},
|
|
1531
|
+
"project:domain:remove": {
|
|
1532
|
+
"aliases": [],
|
|
1150
1533
|
"args": {
|
|
1151
1534
|
"OWNER/PROJECT_NAME": {
|
|
1535
|
+
"description": "The project to remove the domain from on Swaggerhub",
|
|
1152
1536
|
"name": "OWNER/PROJECT_NAME",
|
|
1153
|
-
"description": "The project to add the domain to on Swaggerhub",
|
|
1154
1537
|
"required": true
|
|
1155
1538
|
},
|
|
1156
1539
|
"DOMAIN": {
|
|
1540
|
+
"description": "The name of the domain on Swaggerhub to remove",
|
|
1157
1541
|
"name": "DOMAIN",
|
|
1158
|
-
"description": "The name of the domain on Swaggerhub to add",
|
|
1159
1542
|
"required": true
|
|
1160
1543
|
}
|
|
1161
|
-
}
|
|
1162
|
-
},
|
|
1163
|
-
"project:domain:remove": {
|
|
1164
|
-
"id": "project:domain:remove",
|
|
1544
|
+
},
|
|
1165
1545
|
"description": "Removes a domain from a project in SwaggerHub.",
|
|
1166
|
-
"strict": true,
|
|
1167
|
-
"pluginName": "swaggerhub-cli",
|
|
1168
|
-
"pluginAlias": "swaggerhub-cli",
|
|
1169
|
-
"pluginType": "core",
|
|
1170
|
-
"aliases": [],
|
|
1171
1546
|
"examples": [
|
|
1172
1547
|
"swaggerhub project:domain:remove organization/project_name my_domain"
|
|
1173
1548
|
],
|
|
1174
1549
|
"flags": {
|
|
1175
1550
|
"help": {
|
|
1176
|
-
"name": "help",
|
|
1177
|
-
"type": "boolean",
|
|
1178
1551
|
"char": "h",
|
|
1179
1552
|
"description": "Show CLI help.",
|
|
1180
|
-
"
|
|
1553
|
+
"name": "help",
|
|
1554
|
+
"allowNo": false,
|
|
1555
|
+
"type": "boolean"
|
|
1181
1556
|
}
|
|
1182
1557
|
},
|
|
1558
|
+
"hasDynamicHelp": false,
|
|
1559
|
+
"hiddenAliases": [],
|
|
1560
|
+
"id": "project:domain:remove",
|
|
1561
|
+
"pluginAlias": "swaggerhub-cli",
|
|
1562
|
+
"pluginName": "swaggerhub-cli",
|
|
1563
|
+
"pluginType": "core",
|
|
1564
|
+
"strict": true,
|
|
1565
|
+
"enableJsonFlag": false,
|
|
1566
|
+
"isESM": false,
|
|
1567
|
+
"relativePath": [
|
|
1568
|
+
"src",
|
|
1569
|
+
"commands",
|
|
1570
|
+
"project",
|
|
1571
|
+
"domain",
|
|
1572
|
+
"remove.js"
|
|
1573
|
+
]
|
|
1574
|
+
},
|
|
1575
|
+
"project:member:list": {
|
|
1576
|
+
"aliases": [],
|
|
1183
1577
|
"args": {
|
|
1184
1578
|
"OWNER/PROJECT_NAME": {
|
|
1579
|
+
"description": "Project to list members of on Swaggerhub",
|
|
1185
1580
|
"name": "OWNER/PROJECT_NAME",
|
|
1186
|
-
"description": "The project to remove the domain from on Swaggerhub",
|
|
1187
|
-
"required": true
|
|
1188
|
-
},
|
|
1189
|
-
"DOMAIN": {
|
|
1190
|
-
"name": "DOMAIN",
|
|
1191
|
-
"description": "The name of the domain on Swaggerhub to remove",
|
|
1192
1581
|
"required": true
|
|
1193
1582
|
}
|
|
1194
|
-
}
|
|
1195
|
-
},
|
|
1196
|
-
"project:member:list": {
|
|
1197
|
-
"id": "project:member:list",
|
|
1583
|
+
},
|
|
1198
1584
|
"description": "list members of a project",
|
|
1199
|
-
"strict": true,
|
|
1200
|
-
"pluginName": "swaggerhub-cli",
|
|
1201
|
-
"pluginAlias": "swaggerhub-cli",
|
|
1202
|
-
"pluginType": "core",
|
|
1203
|
-
"aliases": [],
|
|
1204
1585
|
"examples": [
|
|
1205
1586
|
"swaggerhub project:member:list organisation/project_name"
|
|
1206
1587
|
],
|
|
1207
1588
|
"flags": {
|
|
1208
1589
|
"help": {
|
|
1209
|
-
"name": "help",
|
|
1210
|
-
"type": "boolean",
|
|
1211
1590
|
"char": "h",
|
|
1212
1591
|
"description": "Show CLI help.",
|
|
1213
|
-
"
|
|
1592
|
+
"name": "help",
|
|
1593
|
+
"allowNo": false,
|
|
1594
|
+
"type": "boolean"
|
|
1214
1595
|
}
|
|
1215
1596
|
},
|
|
1216
|
-
"
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
|
|
1597
|
+
"hasDynamicHelp": false,
|
|
1598
|
+
"hiddenAliases": [],
|
|
1599
|
+
"id": "project:member:list",
|
|
1600
|
+
"pluginAlias": "swaggerhub-cli",
|
|
1601
|
+
"pluginName": "swaggerhub-cli",
|
|
1602
|
+
"pluginType": "core",
|
|
1603
|
+
"strict": true,
|
|
1604
|
+
"enableJsonFlag": false,
|
|
1605
|
+
"isESM": false,
|
|
1606
|
+
"relativePath": [
|
|
1607
|
+
"src",
|
|
1608
|
+
"commands",
|
|
1609
|
+
"project",
|
|
1610
|
+
"member",
|
|
1611
|
+
"list.js"
|
|
1612
|
+
]
|
|
1223
1613
|
}
|
|
1224
|
-
}
|
|
1614
|
+
},
|
|
1615
|
+
"version": "0.9.1"
|
|
1225
1616
|
}
|