@apimatic/cli 1.2.1 → 1.3.0-beta.2
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 +65 -1
- package/lib/actions/action-result.d.ts +1 -0
- package/lib/actions/action-result.js +3 -0
- package/lib/actions/action-result.js.map +1 -1
- package/lib/actions/plugin/generate.d.ts +12 -0
- package/lib/actions/plugin/generate.js +71 -0
- package/lib/actions/plugin/generate.js.map +1 -0
- package/lib/actions/plugin/publish.d.ts +6 -0
- package/lib/actions/plugin/publish.js +43 -0
- package/lib/actions/plugin/publish.js.map +1 -0
- package/lib/actions/plugin/record-metadata.d.ts +18 -0
- package/lib/actions/plugin/record-metadata.js +57 -0
- package/lib/actions/plugin/record-metadata.js.map +1 -0
- package/lib/actions/plugin/record-sdk.d.ts +14 -0
- package/lib/actions/plugin/record-sdk.js +60 -0
- package/lib/actions/plugin/record-sdk.js.map +1 -0
- package/lib/actions/sdk/generate.d.ts +2 -2
- package/lib/actions/sdk/generate.js +4 -4
- package/lib/actions/sdk/generate.js.map +1 -1
- package/lib/actions/sdk/publish/interactive.js +23 -4
- package/lib/actions/sdk/publish/interactive.js.map +1 -1
- package/lib/actions/sdk/publish/non-interactive.d.ts +2 -2
- package/lib/actions/sdk/publish/non-interactive.js +19 -12
- package/lib/actions/sdk/publish/non-interactive.js.map +1 -1
- package/lib/actions/sdk/publish.d.ts +2 -3
- package/lib/actions/sdk/publish.js +26 -5
- package/lib/actions/sdk/publish.js.map +1 -1
- package/lib/actions/sdk/quickstart.js +2 -2
- package/lib/actions/sdk/quickstart.js.map +1 -1
- package/lib/commands/plugin/generate.d.ts +14 -0
- package/lib/commands/plugin/generate.js +37 -0
- package/lib/commands/plugin/generate.js.map +1 -0
- package/lib/commands/plugin/publish.d.ts +11 -0
- package/lib/commands/plugin/publish.js +29 -0
- package/lib/commands/plugin/publish.js.map +1 -0
- package/lib/commands/sdk/generate.js +4 -3
- package/lib/commands/sdk/generate.js.map +1 -1
- package/lib/commands/sdk/publish.d.ts +3 -0
- package/lib/commands/sdk/publish.js +18 -5
- package/lib/commands/sdk/publish.js.map +1 -1
- package/lib/config/axios-config.d.ts +6 -0
- package/lib/config/axios-config.js +8 -2
- package/lib/config/axios-config.js.map +1 -1
- package/lib/infrastructure/generation-status-poller.d.ts +31 -0
- package/lib/infrastructure/generation-status-poller.js +56 -0
- package/lib/infrastructure/generation-status-poller.js.map +1 -0
- package/lib/infrastructure/service-error.d.ts +10 -1
- package/lib/infrastructure/service-error.js +47 -0
- package/lib/infrastructure/service-error.js.map +1 -1
- package/lib/infrastructure/services/api-service.d.ts +0 -7
- package/lib/infrastructure/services/api-service.js +0 -42
- package/lib/infrastructure/services/api-service.js.map +1 -1
- package/lib/infrastructure/services/plugin-service.d.ts +24 -0
- package/lib/infrastructure/services/plugin-service.js +141 -0
- package/lib/infrastructure/services/plugin-service.js.map +1 -0
- package/lib/infrastructure/services/portal-service.d.ts +16 -8
- package/lib/infrastructure/services/portal-service.js +147 -39
- package/lib/infrastructure/services/portal-service.js.map +1 -1
- package/lib/prompts/format.d.ts +4 -3
- package/lib/prompts/format.js +14 -13
- package/lib/prompts/format.js.map +1 -1
- package/lib/prompts/plugin/generate.d.ts +19 -0
- package/lib/prompts/plugin/generate.js +64 -0
- package/lib/prompts/plugin/generate.js.map +1 -0
- package/lib/prompts/plugin/publish.d.ts +25 -0
- package/lib/prompts/plugin/publish.js +77 -0
- package/lib/prompts/plugin/publish.js.map +1 -0
- package/lib/prompts/plugin/record-metadata.d.ts +25 -0
- package/lib/prompts/plugin/record-metadata.js +70 -0
- package/lib/prompts/plugin/record-metadata.js.map +1 -0
- package/lib/prompts/plugin/record-sdk.d.ts +9 -0
- package/lib/prompts/plugin/record-sdk.js +40 -0
- package/lib/prompts/plugin/record-sdk.js.map +1 -0
- package/lib/prompts/publishing/links.d.ts +1 -0
- package/lib/prompts/publishing/links.js +2 -0
- package/lib/prompts/publishing/links.js.map +1 -0
- package/lib/prompts/publishing/profile/list.js +5 -3
- package/lib/prompts/publishing/profile/list.js.map +1 -1
- package/lib/prompts/sdk/generate.d.ts +2 -0
- package/lib/prompts/sdk/generate.js +7 -0
- package/lib/prompts/sdk/generate.js.map +1 -1
- package/lib/prompts/sdk/publish/interactive.d.ts +7 -5
- package/lib/prompts/sdk/publish/interactive.js +29 -14
- package/lib/prompts/sdk/publish/interactive.js.map +1 -1
- package/lib/prompts/sdk/publish/non-interactive.d.ts +1 -6
- package/lib/prompts/sdk/publish/non-interactive.js +11 -52
- package/lib/prompts/sdk/publish/non-interactive.js.map +1 -1
- package/lib/prompts/sdk/publish.d.ts +15 -2
- package/lib/prompts/sdk/publish.js +71 -5
- package/lib/prompts/sdk/publish.js.map +1 -1
- package/lib/types/file/directory.d.ts +3 -0
- package/lib/types/file/directory.js +13 -0
- package/lib/types/file/directory.js.map +1 -1
- package/lib/types/plugin/generation-status.d.ts +23 -0
- package/lib/types/plugin/generation-status.js +18 -0
- package/lib/types/plugin/generation-status.js.map +1 -0
- package/lib/types/plugin/language-entry.d.ts +9 -0
- package/lib/types/plugin/language-entry.js +64 -0
- package/lib/types/plugin/language-entry.js.map +1 -0
- package/lib/types/plugin/plugin-config.d.ts +72 -0
- package/lib/types/plugin/plugin-config.js +4 -0
- package/lib/types/plugin/plugin-config.js.map +1 -0
- package/lib/types/plugin/plugin-contents.d.ts +5 -0
- package/lib/types/plugin/plugin-contents.js +2 -0
- package/lib/types/plugin/plugin-contents.js.map +1 -0
- package/lib/types/plugin-config-context.d.ts +63 -0
- package/lib/types/plugin-config-context.js +179 -0
- package/lib/types/plugin-config-context.js.map +1 -0
- package/lib/types/plugin-context.d.ts +13 -0
- package/lib/types/plugin-context.js +28 -0
- package/lib/types/plugin-context.js.map +1 -0
- package/lib/types/publish/package-settings-configuration.d.ts +11 -1
- package/lib/types/publish/package-settings-configuration.js +1 -1
- package/lib/types/publish/package-settings-configuration.js.map +1 -1
- package/lib/types/publish/publishing-profile.d.ts +3 -2
- package/lib/types/publish/publishing-profile.js +24 -18
- package/lib/types/publish/publishing-profile.js.map +1 -1
- package/lib/types/publish/publishing-profiles.d.ts +1 -1
- package/lib/types/publish/publishing-profiles.js +1 -1
- package/lib/types/publish/publishing-profiles.js.map +1 -1
- package/lib/types/publish/version.d.ts +6 -1
- package/lib/types/publish/version.js +2 -1
- package/lib/types/publish/version.js.map +1 -1
- package/lib/types/sdk/generate.d.ts +19 -0
- package/lib/types/sdk/generate.js +44 -0
- package/lib/types/sdk/generate.js.map +1 -1
- package/lib/types/utils.d.ts +1 -0
- package/oclif.manifest.json +1040 -0
- package/package.json +7 -4
- package/lib/types/api/generation-status-endpoint.d.ts +0 -8
- package/lib/types/api/generation-status-endpoint.js +0 -12
- package/lib/types/api/generation-status-endpoint.js.map +0 -1
|
@@ -0,0 +1,1040 @@
|
|
|
1
|
+
{
|
|
2
|
+
"commands": {
|
|
3
|
+
"quickstart": {
|
|
4
|
+
"aliases": [],
|
|
5
|
+
"args": {},
|
|
6
|
+
"description": "Get started with your first SDK or API Portal in four easy steps.",
|
|
7
|
+
"examples": [
|
|
8
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mquickstart\u001b[22m"
|
|
9
|
+
],
|
|
10
|
+
"flags": {},
|
|
11
|
+
"hasDynamicHelp": false,
|
|
12
|
+
"hiddenAliases": [],
|
|
13
|
+
"id": "quickstart",
|
|
14
|
+
"pluginAlias": "@apimatic/cli",
|
|
15
|
+
"pluginName": "@apimatic/cli",
|
|
16
|
+
"pluginType": "core",
|
|
17
|
+
"strict": true,
|
|
18
|
+
"summary": "Create your first API Portal, Context Plugins and SDKs, or a standalone SDK, using APIMatic.",
|
|
19
|
+
"enableJsonFlag": false,
|
|
20
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mquickstart\u001b[22m",
|
|
21
|
+
"isESM": true,
|
|
22
|
+
"relativePath": [
|
|
23
|
+
"lib",
|
|
24
|
+
"commands",
|
|
25
|
+
"quickstart.js"
|
|
26
|
+
]
|
|
27
|
+
},
|
|
28
|
+
"api:transform": {
|
|
29
|
+
"aliases": [],
|
|
30
|
+
"args": {},
|
|
31
|
+
"description": "Transform API specifications from one format to another.\nSupports multiple formats including OpenAPI/Swagger, RAML, WSDL, and Postman Collections.",
|
|
32
|
+
"examples": [
|
|
33
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mapi\u001b[22m \u001b[2mtransform\u001b[22m \u001b[32m--format\u001b[39m=\u001b[2mopenapi3yaml\u001b[22m \u001b[32m--file\u001b[39m=\u001b[2m./specs/sample.json\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m./\u001b[22m",
|
|
34
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mapi\u001b[22m \u001b[2mtransform\u001b[22m \u001b[32m--format\u001b[39m=\u001b[2mraml\u001b[22m \u001b[32m--url\u001b[39m=\u001b[2m\"https://petstore.swagger.io/v2/swagger.json\"\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m./\u001b[22m"
|
|
35
|
+
],
|
|
36
|
+
"flags": {
|
|
37
|
+
"format": {
|
|
38
|
+
"description": "Specification format to transform API specification into",
|
|
39
|
+
"name": "format",
|
|
40
|
+
"required": true,
|
|
41
|
+
"hasDynamicHelp": false,
|
|
42
|
+
"multiple": false,
|
|
43
|
+
"options": [
|
|
44
|
+
"apimatic",
|
|
45
|
+
"wadl2009",
|
|
46
|
+
"wsdl",
|
|
47
|
+
"swagger10",
|
|
48
|
+
"swagger20",
|
|
49
|
+
"swaggeryaml",
|
|
50
|
+
"oas3",
|
|
51
|
+
"openapi3yaml",
|
|
52
|
+
"apiblueprint",
|
|
53
|
+
"raml",
|
|
54
|
+
"raml10",
|
|
55
|
+
"postman10",
|
|
56
|
+
"postman20",
|
|
57
|
+
"graphqlschema"
|
|
58
|
+
],
|
|
59
|
+
"type": "option"
|
|
60
|
+
},
|
|
61
|
+
"file": {
|
|
62
|
+
"description": "Path to the API specification file to transform",
|
|
63
|
+
"name": "file",
|
|
64
|
+
"hasDynamicHelp": false,
|
|
65
|
+
"multiple": false,
|
|
66
|
+
"type": "option"
|
|
67
|
+
},
|
|
68
|
+
"url": {
|
|
69
|
+
"description": "URL to the API specification file to transform (publicly accessible)",
|
|
70
|
+
"name": "url",
|
|
71
|
+
"hasDynamicHelp": false,
|
|
72
|
+
"multiple": false,
|
|
73
|
+
"type": "option"
|
|
74
|
+
},
|
|
75
|
+
"destination": {
|
|
76
|
+
"char": "d",
|
|
77
|
+
"description": "Directory to save the transformed file to",
|
|
78
|
+
"name": "destination",
|
|
79
|
+
"default": "./",
|
|
80
|
+
"hasDynamicHelp": false,
|
|
81
|
+
"multiple": false,
|
|
82
|
+
"type": "option"
|
|
83
|
+
},
|
|
84
|
+
"force": {
|
|
85
|
+
"char": "f",
|
|
86
|
+
"description": "overwrite changes without asking for user consent.",
|
|
87
|
+
"name": "force",
|
|
88
|
+
"allowNo": false,
|
|
89
|
+
"type": "boolean"
|
|
90
|
+
},
|
|
91
|
+
"auth-key": {
|
|
92
|
+
"char": "k",
|
|
93
|
+
"description": "override current authentication state with an authentication key.",
|
|
94
|
+
"name": "auth-key",
|
|
95
|
+
"hasDynamicHelp": false,
|
|
96
|
+
"multiple": false,
|
|
97
|
+
"type": "option"
|
|
98
|
+
}
|
|
99
|
+
},
|
|
100
|
+
"hasDynamicHelp": false,
|
|
101
|
+
"hiddenAliases": [],
|
|
102
|
+
"id": "api:transform",
|
|
103
|
+
"pluginAlias": "@apimatic/cli",
|
|
104
|
+
"pluginName": "@apimatic/cli",
|
|
105
|
+
"pluginType": "core",
|
|
106
|
+
"strict": true,
|
|
107
|
+
"summary": "Transform API specifications between different formats",
|
|
108
|
+
"enableJsonFlag": false,
|
|
109
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mapi\u001b[22m \u001b[2mtransform\u001b[22m",
|
|
110
|
+
"isESM": true,
|
|
111
|
+
"relativePath": [
|
|
112
|
+
"lib",
|
|
113
|
+
"commands",
|
|
114
|
+
"api",
|
|
115
|
+
"transform.js"
|
|
116
|
+
]
|
|
117
|
+
},
|
|
118
|
+
"api:validate": {
|
|
119
|
+
"aliases": [],
|
|
120
|
+
"args": {},
|
|
121
|
+
"description": "Validate your API specification to ensure it adheres to syntactic and semantic standards.",
|
|
122
|
+
"examples": [
|
|
123
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mapi\u001b[22m \u001b[2mvalidate\u001b[22m \u001b[32m--file\u001b[39m=\u001b[2m./specs/sample.json\u001b[22m",
|
|
124
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mapi\u001b[22m \u001b[2mvalidate\u001b[22m \u001b[32m--url\u001b[39m=\u001b[2m\"https://petstore.swagger.io/v2/swagger.json\"\u001b[22m"
|
|
125
|
+
],
|
|
126
|
+
"flags": {
|
|
127
|
+
"file": {
|
|
128
|
+
"description": "Path to the API specification file to validate",
|
|
129
|
+
"name": "file",
|
|
130
|
+
"hasDynamicHelp": false,
|
|
131
|
+
"multiple": false,
|
|
132
|
+
"type": "option"
|
|
133
|
+
},
|
|
134
|
+
"url": {
|
|
135
|
+
"description": "URL to the API specification file to validate (publicly accessible)",
|
|
136
|
+
"name": "url",
|
|
137
|
+
"hasDynamicHelp": false,
|
|
138
|
+
"multiple": false,
|
|
139
|
+
"type": "option"
|
|
140
|
+
},
|
|
141
|
+
"auth-key": {
|
|
142
|
+
"char": "k",
|
|
143
|
+
"description": "override current authentication state with an authentication key.",
|
|
144
|
+
"name": "auth-key",
|
|
145
|
+
"hasDynamicHelp": false,
|
|
146
|
+
"multiple": false,
|
|
147
|
+
"type": "option"
|
|
148
|
+
}
|
|
149
|
+
},
|
|
150
|
+
"hasDynamicHelp": false,
|
|
151
|
+
"hiddenAliases": [],
|
|
152
|
+
"id": "api:validate",
|
|
153
|
+
"pluginAlias": "@apimatic/cli",
|
|
154
|
+
"pluginName": "@apimatic/cli",
|
|
155
|
+
"pluginType": "core",
|
|
156
|
+
"strict": true,
|
|
157
|
+
"summary": "Validate API specification for syntactic and semantic correctness",
|
|
158
|
+
"enableJsonFlag": false,
|
|
159
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mapi\u001b[22m \u001b[2mvalidate\u001b[22m",
|
|
160
|
+
"isESM": true,
|
|
161
|
+
"relativePath": [
|
|
162
|
+
"lib",
|
|
163
|
+
"commands",
|
|
164
|
+
"api",
|
|
165
|
+
"validate.js"
|
|
166
|
+
]
|
|
167
|
+
},
|
|
168
|
+
"auth:login": {
|
|
169
|
+
"aliases": [],
|
|
170
|
+
"args": {},
|
|
171
|
+
"description": "Login using your APIMatic credentials or an API Key",
|
|
172
|
+
"examples": [
|
|
173
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mauth\u001b[22m \u001b[2mlogin\u001b[22m",
|
|
174
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mauth\u001b[22m \u001b[2mlogin\u001b[22m \u001b[32m--auth-key\u001b[39m=\u001b[2m{api-key}\u001b[22m"
|
|
175
|
+
],
|
|
176
|
+
"flags": {
|
|
177
|
+
"auth-key": {
|
|
178
|
+
"char": "k",
|
|
179
|
+
"description": "Sets authentication key for all commands.",
|
|
180
|
+
"name": "auth-key",
|
|
181
|
+
"hasDynamicHelp": false,
|
|
182
|
+
"multiple": false,
|
|
183
|
+
"type": "option"
|
|
184
|
+
}
|
|
185
|
+
},
|
|
186
|
+
"hasDynamicHelp": false,
|
|
187
|
+
"hiddenAliases": [],
|
|
188
|
+
"id": "auth:login",
|
|
189
|
+
"pluginAlias": "@apimatic/cli",
|
|
190
|
+
"pluginName": "@apimatic/cli",
|
|
191
|
+
"pluginType": "core",
|
|
192
|
+
"strict": true,
|
|
193
|
+
"summary": "Login to your APIMatic account",
|
|
194
|
+
"enableJsonFlag": false,
|
|
195
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mauth\u001b[22m \u001b[2mlogin\u001b[22m",
|
|
196
|
+
"isESM": true,
|
|
197
|
+
"relativePath": [
|
|
198
|
+
"lib",
|
|
199
|
+
"commands",
|
|
200
|
+
"auth",
|
|
201
|
+
"login.js"
|
|
202
|
+
]
|
|
203
|
+
},
|
|
204
|
+
"auth:logout": {
|
|
205
|
+
"aliases": [],
|
|
206
|
+
"args": {},
|
|
207
|
+
"description": "Clears the local login credentials. This will also clear any cached credentials from the CLI.",
|
|
208
|
+
"examples": [
|
|
209
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mauth\u001b[22m \u001b[2mlogout\u001b[22m"
|
|
210
|
+
],
|
|
211
|
+
"flags": {},
|
|
212
|
+
"hasDynamicHelp": false,
|
|
213
|
+
"hiddenAliases": [],
|
|
214
|
+
"id": "auth:logout",
|
|
215
|
+
"pluginAlias": "@apimatic/cli",
|
|
216
|
+
"pluginName": "@apimatic/cli",
|
|
217
|
+
"pluginType": "core",
|
|
218
|
+
"strict": true,
|
|
219
|
+
"summary": "Clears the local login credentials.",
|
|
220
|
+
"enableJsonFlag": false,
|
|
221
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mauth\u001b[22m \u001b[2mlogout\u001b[22m",
|
|
222
|
+
"isESM": true,
|
|
223
|
+
"relativePath": [
|
|
224
|
+
"lib",
|
|
225
|
+
"commands",
|
|
226
|
+
"auth",
|
|
227
|
+
"logout.js"
|
|
228
|
+
]
|
|
229
|
+
},
|
|
230
|
+
"auth:status": {
|
|
231
|
+
"aliases": [],
|
|
232
|
+
"args": {},
|
|
233
|
+
"description": "View the currently logged in user.",
|
|
234
|
+
"examples": [
|
|
235
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mauth\u001b[22m \u001b[2mstatus\u001b[22m"
|
|
236
|
+
],
|
|
237
|
+
"flags": {},
|
|
238
|
+
"hasDynamicHelp": false,
|
|
239
|
+
"hiddenAliases": [],
|
|
240
|
+
"id": "auth:status",
|
|
241
|
+
"pluginAlias": "@apimatic/cli",
|
|
242
|
+
"pluginName": "@apimatic/cli",
|
|
243
|
+
"pluginType": "core",
|
|
244
|
+
"strict": true,
|
|
245
|
+
"enableJsonFlag": false,
|
|
246
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mauth\u001b[22m \u001b[2mstatus\u001b[22m",
|
|
247
|
+
"isESM": true,
|
|
248
|
+
"relativePath": [
|
|
249
|
+
"lib",
|
|
250
|
+
"commands",
|
|
251
|
+
"auth",
|
|
252
|
+
"status.js"
|
|
253
|
+
]
|
|
254
|
+
},
|
|
255
|
+
"plugin:generate": {
|
|
256
|
+
"aliases": [],
|
|
257
|
+
"args": {},
|
|
258
|
+
"description": "Generate a context plugin that teaches an AI coding assistant how to use your SDKs. Requires an input directory containing a `src` directory with a `plugin-config.json`.",
|
|
259
|
+
"examples": [
|
|
260
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mplugin\u001b[22m \u001b[2mgenerate\u001b[22m",
|
|
261
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mplugin\u001b[22m \u001b[2mgenerate\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m\"./\"\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m\"./plugin\"\u001b[22m"
|
|
262
|
+
],
|
|
263
|
+
"flags": {
|
|
264
|
+
"input": {
|
|
265
|
+
"char": "i",
|
|
266
|
+
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
267
|
+
"name": "input",
|
|
268
|
+
"hasDynamicHelp": false,
|
|
269
|
+
"multiple": false,
|
|
270
|
+
"type": "option"
|
|
271
|
+
},
|
|
272
|
+
"destination": {
|
|
273
|
+
"char": "d",
|
|
274
|
+
"description": "[default: <input>/plugin] path where the plugin will be generated.",
|
|
275
|
+
"name": "destination",
|
|
276
|
+
"hasDynamicHelp": false,
|
|
277
|
+
"multiple": false,
|
|
278
|
+
"type": "option"
|
|
279
|
+
},
|
|
280
|
+
"force": {
|
|
281
|
+
"char": "f",
|
|
282
|
+
"description": "overwrite changes without asking for user consent.",
|
|
283
|
+
"name": "force",
|
|
284
|
+
"allowNo": false,
|
|
285
|
+
"type": "boolean"
|
|
286
|
+
},
|
|
287
|
+
"auth-key": {
|
|
288
|
+
"char": "k",
|
|
289
|
+
"description": "override current authentication state with an authentication key.",
|
|
290
|
+
"name": "auth-key",
|
|
291
|
+
"hasDynamicHelp": false,
|
|
292
|
+
"multiple": false,
|
|
293
|
+
"type": "option"
|
|
294
|
+
}
|
|
295
|
+
},
|
|
296
|
+
"hasDynamicHelp": false,
|
|
297
|
+
"hiddenAliases": [],
|
|
298
|
+
"id": "plugin:generate",
|
|
299
|
+
"pluginAlias": "@apimatic/cli",
|
|
300
|
+
"pluginName": "@apimatic/cli",
|
|
301
|
+
"pluginType": "core",
|
|
302
|
+
"strict": true,
|
|
303
|
+
"summary": "Generate a Claude Code context plugin for your published SDKs.",
|
|
304
|
+
"enableJsonFlag": false,
|
|
305
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mplugin\u001b[22m \u001b[2mgenerate\u001b[22m",
|
|
306
|
+
"isESM": true,
|
|
307
|
+
"relativePath": [
|
|
308
|
+
"lib",
|
|
309
|
+
"commands",
|
|
310
|
+
"plugin",
|
|
311
|
+
"generate.js"
|
|
312
|
+
]
|
|
313
|
+
},
|
|
314
|
+
"plugin:publish": {
|
|
315
|
+
"aliases": [],
|
|
316
|
+
"args": {},
|
|
317
|
+
"description": "Print the commands that publish a generated context plugin to a GitHub repository. The commands are printed for you to run — this command never touches your repository.",
|
|
318
|
+
"examples": [
|
|
319
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mplugin\u001b[22m \u001b[2mpublish\u001b[22m",
|
|
320
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mplugin\u001b[22m \u001b[2mpublish\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m\"./\"\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m\"./plugin\"\u001b[22m"
|
|
321
|
+
],
|
|
322
|
+
"flags": {
|
|
323
|
+
"input": {
|
|
324
|
+
"char": "i",
|
|
325
|
+
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
326
|
+
"name": "input",
|
|
327
|
+
"hasDynamicHelp": false,
|
|
328
|
+
"multiple": false,
|
|
329
|
+
"type": "option"
|
|
330
|
+
},
|
|
331
|
+
"destination": {
|
|
332
|
+
"char": "d",
|
|
333
|
+
"description": "[default: <input>/plugin] path where the plugin was generated.",
|
|
334
|
+
"name": "destination",
|
|
335
|
+
"hasDynamicHelp": false,
|
|
336
|
+
"multiple": false,
|
|
337
|
+
"type": "option"
|
|
338
|
+
}
|
|
339
|
+
},
|
|
340
|
+
"hasDynamicHelp": false,
|
|
341
|
+
"hiddenAliases": [],
|
|
342
|
+
"id": "plugin:publish",
|
|
343
|
+
"pluginAlias": "@apimatic/cli",
|
|
344
|
+
"pluginName": "@apimatic/cli",
|
|
345
|
+
"pluginType": "core",
|
|
346
|
+
"strict": true,
|
|
347
|
+
"summary": "Print the git commands for publishing your context plugin to GitHub.",
|
|
348
|
+
"enableJsonFlag": false,
|
|
349
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mplugin\u001b[22m \u001b[2mpublish\u001b[22m",
|
|
350
|
+
"isESM": true,
|
|
351
|
+
"relativePath": [
|
|
352
|
+
"lib",
|
|
353
|
+
"commands",
|
|
354
|
+
"plugin",
|
|
355
|
+
"publish.js"
|
|
356
|
+
]
|
|
357
|
+
},
|
|
358
|
+
"portal:copilot": {
|
|
359
|
+
"aliases": [],
|
|
360
|
+
"args": {},
|
|
361
|
+
"description": "Displays available API Copilots associated with your account and allows you to select which one to integrate with your portal. Each APIMatic account includes one Copilot by default. The selected Copilot will be added to your \u001b[35m'APIMATIC-BUILD.json'\u001b[39m file",
|
|
362
|
+
"examples": [
|
|
363
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mcopilot\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m./\u001b[22m",
|
|
364
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mcopilot\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m./\u001b[22m \u001b[32m--disable\u001b[39m"
|
|
365
|
+
],
|
|
366
|
+
"flags": {
|
|
367
|
+
"input": {
|
|
368
|
+
"char": "i",
|
|
369
|
+
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
370
|
+
"name": "input",
|
|
371
|
+
"hasDynamicHelp": false,
|
|
372
|
+
"multiple": false,
|
|
373
|
+
"type": "option"
|
|
374
|
+
},
|
|
375
|
+
"disable": {
|
|
376
|
+
"description": "marks the API Copilot as disabled in the configuration",
|
|
377
|
+
"name": "disable",
|
|
378
|
+
"allowNo": false,
|
|
379
|
+
"type": "boolean"
|
|
380
|
+
},
|
|
381
|
+
"force": {
|
|
382
|
+
"char": "f",
|
|
383
|
+
"description": "overwrite changes without asking for user consent.",
|
|
384
|
+
"name": "force",
|
|
385
|
+
"allowNo": false,
|
|
386
|
+
"type": "boolean"
|
|
387
|
+
},
|
|
388
|
+
"auth-key": {
|
|
389
|
+
"char": "k",
|
|
390
|
+
"description": "override current authentication state with an authentication key.",
|
|
391
|
+
"name": "auth-key",
|
|
392
|
+
"hasDynamicHelp": false,
|
|
393
|
+
"multiple": false,
|
|
394
|
+
"type": "option"
|
|
395
|
+
}
|
|
396
|
+
},
|
|
397
|
+
"hasDynamicHelp": false,
|
|
398
|
+
"hiddenAliases": [],
|
|
399
|
+
"id": "portal:copilot",
|
|
400
|
+
"pluginAlias": "@apimatic/cli",
|
|
401
|
+
"pluginName": "@apimatic/cli",
|
|
402
|
+
"pluginType": "core",
|
|
403
|
+
"strict": true,
|
|
404
|
+
"summary": "Configure API Copilot for your API Documentation portal",
|
|
405
|
+
"enableJsonFlag": false,
|
|
406
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mcopilot\u001b[22m",
|
|
407
|
+
"isESM": true,
|
|
408
|
+
"relativePath": [
|
|
409
|
+
"lib",
|
|
410
|
+
"commands",
|
|
411
|
+
"portal",
|
|
412
|
+
"copilot.js"
|
|
413
|
+
]
|
|
414
|
+
},
|
|
415
|
+
"portal:generate": {
|
|
416
|
+
"aliases": [],
|
|
417
|
+
"args": {},
|
|
418
|
+
"description": "Generate an API Documentation portal. Requires an input directory containing API specifications, a config file and optionally, markdown guides. For details, refer to the [documentation](https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/build-file-reference)",
|
|
419
|
+
"examples": [
|
|
420
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mgenerate\u001b[22m",
|
|
421
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mgenerate\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m\"./\"\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m\"./portal\"\u001b[22m"
|
|
422
|
+
],
|
|
423
|
+
"flags": {
|
|
424
|
+
"input": {
|
|
425
|
+
"char": "i",
|
|
426
|
+
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
427
|
+
"name": "input",
|
|
428
|
+
"hasDynamicHelp": false,
|
|
429
|
+
"multiple": false,
|
|
430
|
+
"type": "option"
|
|
431
|
+
},
|
|
432
|
+
"destination": {
|
|
433
|
+
"char": "d",
|
|
434
|
+
"description": "[default: <input>/portal] path where the portal will be generated.",
|
|
435
|
+
"name": "destination",
|
|
436
|
+
"hasDynamicHelp": false,
|
|
437
|
+
"multiple": false,
|
|
438
|
+
"type": "option"
|
|
439
|
+
},
|
|
440
|
+
"force": {
|
|
441
|
+
"char": "f",
|
|
442
|
+
"description": "overwrite changes without asking for user consent.",
|
|
443
|
+
"name": "force",
|
|
444
|
+
"allowNo": false,
|
|
445
|
+
"type": "boolean"
|
|
446
|
+
},
|
|
447
|
+
"zip": {
|
|
448
|
+
"description": "Download the generated portal as a .zip archive",
|
|
449
|
+
"name": "zip",
|
|
450
|
+
"allowNo": false,
|
|
451
|
+
"type": "boolean"
|
|
452
|
+
},
|
|
453
|
+
"auth-key": {
|
|
454
|
+
"char": "k",
|
|
455
|
+
"description": "override current authentication state with an authentication key.",
|
|
456
|
+
"name": "auth-key",
|
|
457
|
+
"hasDynamicHelp": false,
|
|
458
|
+
"multiple": false,
|
|
459
|
+
"type": "option"
|
|
460
|
+
}
|
|
461
|
+
},
|
|
462
|
+
"hasDynamicHelp": false,
|
|
463
|
+
"hiddenAliases": [],
|
|
464
|
+
"id": "portal:generate",
|
|
465
|
+
"pluginAlias": "@apimatic/cli",
|
|
466
|
+
"pluginName": "@apimatic/cli",
|
|
467
|
+
"pluginType": "core",
|
|
468
|
+
"strict": true,
|
|
469
|
+
"summary": "Generate Context Plugins and API Documentation Portal with AI Assist Features.",
|
|
470
|
+
"enableJsonFlag": false,
|
|
471
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mgenerate\u001b[22m",
|
|
472
|
+
"isESM": true,
|
|
473
|
+
"relativePath": [
|
|
474
|
+
"lib",
|
|
475
|
+
"commands",
|
|
476
|
+
"portal",
|
|
477
|
+
"generate.js"
|
|
478
|
+
]
|
|
479
|
+
},
|
|
480
|
+
"portal:serve": {
|
|
481
|
+
"aliases": [],
|
|
482
|
+
"args": {},
|
|
483
|
+
"description": "Requires an input directory with API specifications, a config file, and optionally markdown guides. Supports disabling hot reload and opening the portal in the default browser.",
|
|
484
|
+
"examples": [
|
|
485
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mserve\u001b[22m",
|
|
486
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mserve\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m./\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m./portal\u001b[22m \u001b[32m--port\u001b[39m=\u001b[2m23513\u001b[22m \u001b[32m--open\u001b[39m \u001b[32m--no-reload\u001b[39m"
|
|
487
|
+
],
|
|
488
|
+
"flags": {
|
|
489
|
+
"port": {
|
|
490
|
+
"char": "p",
|
|
491
|
+
"description": "port to serve the portal.",
|
|
492
|
+
"name": "port",
|
|
493
|
+
"default": 23513,
|
|
494
|
+
"hasDynamicHelp": false,
|
|
495
|
+
"helpValue": "23513",
|
|
496
|
+
"multiple": false,
|
|
497
|
+
"type": "option"
|
|
498
|
+
},
|
|
499
|
+
"input": {
|
|
500
|
+
"char": "i",
|
|
501
|
+
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
502
|
+
"name": "input",
|
|
503
|
+
"hasDynamicHelp": false,
|
|
504
|
+
"multiple": false,
|
|
505
|
+
"type": "option"
|
|
506
|
+
},
|
|
507
|
+
"destination": {
|
|
508
|
+
"char": "d",
|
|
509
|
+
"description": "[default: <input>/portal] path where the portal will be generated.",
|
|
510
|
+
"name": "destination",
|
|
511
|
+
"hasDynamicHelp": false,
|
|
512
|
+
"multiple": false,
|
|
513
|
+
"type": "option"
|
|
514
|
+
},
|
|
515
|
+
"open": {
|
|
516
|
+
"char": "o",
|
|
517
|
+
"description": "open the portal in the default browser.",
|
|
518
|
+
"name": "open",
|
|
519
|
+
"allowNo": false,
|
|
520
|
+
"type": "boolean"
|
|
521
|
+
},
|
|
522
|
+
"no-reload": {
|
|
523
|
+
"description": "disable hot reload.",
|
|
524
|
+
"name": "no-reload",
|
|
525
|
+
"allowNo": false,
|
|
526
|
+
"type": "boolean"
|
|
527
|
+
},
|
|
528
|
+
"auth-key": {
|
|
529
|
+
"char": "k",
|
|
530
|
+
"description": "override current authentication state with an authentication key.",
|
|
531
|
+
"name": "auth-key",
|
|
532
|
+
"hasDynamicHelp": false,
|
|
533
|
+
"multiple": false,
|
|
534
|
+
"type": "option"
|
|
535
|
+
}
|
|
536
|
+
},
|
|
537
|
+
"hasDynamicHelp": false,
|
|
538
|
+
"hiddenAliases": [],
|
|
539
|
+
"id": "portal:serve",
|
|
540
|
+
"pluginAlias": "@apimatic/cli",
|
|
541
|
+
"pluginName": "@apimatic/cli",
|
|
542
|
+
"pluginType": "core",
|
|
543
|
+
"strict": true,
|
|
544
|
+
"summary": "Generate and serve an API Documentation Portal with hot reload.",
|
|
545
|
+
"enableJsonFlag": false,
|
|
546
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mserve\u001b[22m",
|
|
547
|
+
"isESM": true,
|
|
548
|
+
"relativePath": [
|
|
549
|
+
"lib",
|
|
550
|
+
"commands",
|
|
551
|
+
"portal",
|
|
552
|
+
"serve.js"
|
|
553
|
+
]
|
|
554
|
+
},
|
|
555
|
+
"sdk:generate": {
|
|
556
|
+
"aliases": [],
|
|
557
|
+
"args": {},
|
|
558
|
+
"description": "Generate Software Development Kits (SDKs) from API specifications.\nSupports multiple programming languages including Java, C#, Python, JavaScript, and more.",
|
|
559
|
+
"examples": [
|
|
560
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mgenerate\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mjava\u001b[22m",
|
|
561
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mgenerate\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mcsharp\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m./\u001b[22m",
|
|
562
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mgenerate\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mpython\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m./sdk\u001b[22m \u001b[32m--zip\u001b[39m"
|
|
563
|
+
],
|
|
564
|
+
"flags": {
|
|
565
|
+
"language": {
|
|
566
|
+
"char": "l",
|
|
567
|
+
"description": "Programming language for SDK generation",
|
|
568
|
+
"name": "language",
|
|
569
|
+
"required": true,
|
|
570
|
+
"hasDynamicHelp": false,
|
|
571
|
+
"multiple": false,
|
|
572
|
+
"options": [
|
|
573
|
+
"csharp",
|
|
574
|
+
"java",
|
|
575
|
+
"php",
|
|
576
|
+
"python",
|
|
577
|
+
"ruby",
|
|
578
|
+
"typescript",
|
|
579
|
+
"go"
|
|
580
|
+
],
|
|
581
|
+
"type": "option"
|
|
582
|
+
},
|
|
583
|
+
"destination": {
|
|
584
|
+
"char": "d",
|
|
585
|
+
"description": "[default: <input>/sdk/<language> | <input>/sdk/<api-version>/<language>] path where the SDK will be generated",
|
|
586
|
+
"name": "destination",
|
|
587
|
+
"hasDynamicHelp": false,
|
|
588
|
+
"multiple": false,
|
|
589
|
+
"type": "option"
|
|
590
|
+
},
|
|
591
|
+
"skip-changes": {
|
|
592
|
+
"description": "Do not apply the saved changes to the generated SDK",
|
|
593
|
+
"name": "skip-changes",
|
|
594
|
+
"allowNo": false,
|
|
595
|
+
"type": "boolean"
|
|
596
|
+
},
|
|
597
|
+
"api-version": {
|
|
598
|
+
"description": "Version of the API to use for SDK generation (if multiple versions exist)",
|
|
599
|
+
"name": "api-version",
|
|
600
|
+
"hasDynamicHelp": false,
|
|
601
|
+
"multiple": false,
|
|
602
|
+
"type": "option"
|
|
603
|
+
},
|
|
604
|
+
"zip": {
|
|
605
|
+
"description": "Download the generated SDK as a .zip archive",
|
|
606
|
+
"name": "zip",
|
|
607
|
+
"allowNo": false,
|
|
608
|
+
"type": "boolean"
|
|
609
|
+
},
|
|
610
|
+
"track-changes": {
|
|
611
|
+
"description": "Enable change tracking for SDK generation (only required for initial setup)",
|
|
612
|
+
"name": "track-changes",
|
|
613
|
+
"allowNo": false,
|
|
614
|
+
"type": "boolean"
|
|
615
|
+
},
|
|
616
|
+
"codegen-version": {
|
|
617
|
+
"description": "Version of the code generator to use",
|
|
618
|
+
"name": "codegen-version",
|
|
619
|
+
"default": "v3",
|
|
620
|
+
"hasDynamicHelp": false,
|
|
621
|
+
"multiple": false,
|
|
622
|
+
"options": [
|
|
623
|
+
"v3",
|
|
624
|
+
"v4"
|
|
625
|
+
],
|
|
626
|
+
"type": "option"
|
|
627
|
+
},
|
|
628
|
+
"stability": {
|
|
629
|
+
"description": "Stability level of the generated SDK",
|
|
630
|
+
"name": "stability",
|
|
631
|
+
"default": "stable",
|
|
632
|
+
"hasDynamicHelp": false,
|
|
633
|
+
"multiple": false,
|
|
634
|
+
"options": [
|
|
635
|
+
"stable",
|
|
636
|
+
"beta"
|
|
637
|
+
],
|
|
638
|
+
"type": "option"
|
|
639
|
+
},
|
|
640
|
+
"input": {
|
|
641
|
+
"char": "i",
|
|
642
|
+
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
643
|
+
"name": "input",
|
|
644
|
+
"hasDynamicHelp": false,
|
|
645
|
+
"multiple": false,
|
|
646
|
+
"type": "option"
|
|
647
|
+
},
|
|
648
|
+
"force": {
|
|
649
|
+
"char": "f",
|
|
650
|
+
"description": "overwrite changes without asking for user consent.",
|
|
651
|
+
"name": "force",
|
|
652
|
+
"allowNo": false,
|
|
653
|
+
"type": "boolean"
|
|
654
|
+
},
|
|
655
|
+
"auth-key": {
|
|
656
|
+
"char": "k",
|
|
657
|
+
"description": "override current authentication state with an authentication key.",
|
|
658
|
+
"name": "auth-key",
|
|
659
|
+
"hasDynamicHelp": false,
|
|
660
|
+
"multiple": false,
|
|
661
|
+
"type": "option"
|
|
662
|
+
}
|
|
663
|
+
},
|
|
664
|
+
"hasDynamicHelp": false,
|
|
665
|
+
"hiddenAliases": [],
|
|
666
|
+
"id": "sdk:generate",
|
|
667
|
+
"pluginAlias": "@apimatic/cli",
|
|
668
|
+
"pluginName": "@apimatic/cli",
|
|
669
|
+
"pluginType": "core",
|
|
670
|
+
"strict": true,
|
|
671
|
+
"summary": "Generate an SDK for your API",
|
|
672
|
+
"enableJsonFlag": false,
|
|
673
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mgenerate\u001b[22m",
|
|
674
|
+
"isESM": true,
|
|
675
|
+
"relativePath": [
|
|
676
|
+
"lib",
|
|
677
|
+
"commands",
|
|
678
|
+
"sdk",
|
|
679
|
+
"generate.js"
|
|
680
|
+
]
|
|
681
|
+
},
|
|
682
|
+
"sdk:publish": {
|
|
683
|
+
"aliases": [],
|
|
684
|
+
"args": {},
|
|
685
|
+
"description": "Generate and publish an SDK using a publishing profile configured in the APIMatic App. Requires an input directory containing the API specification. Run without flags for a step-by-step interactive experience, or pass all required flags for CI/CD automation.",
|
|
686
|
+
"examples": [
|
|
687
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mpublish\u001b[22m",
|
|
688
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mpublish\u001b[22m \u001b[32m--profile-id\u001b[39m=\u001b[2ma1b2c3d4e5f6a1b2c3d4e5f6\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mtypescript\u001b[22m \u001b[32m--version\u001b[39m=\u001b[2m1.0.0\u001b[22m \u001b[32m--publish-type\u001b[39m=\u001b[2mpackage\u001b[22m \u001b[32m--publish-type\u001b[39m=\u001b[2msourcecode\u001b[22m",
|
|
689
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mpublish\u001b[22m \u001b[32m--profile-id\u001b[39m=\u001b[2mb2c3d4e5f6a1b2c3d4e5f6a1\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mjava\u001b[22m \u001b[32m--version\u001b[39m=\u001b[2m2.0.0\u001b[22m \u001b[32m--publish-type\u001b[39m=\u001b[2msourcecode\u001b[22m",
|
|
690
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mpublish\u001b[22m \u001b[32m--profile-id\u001b[39m=\u001b[2mc3d4e5f6a1b2c3d4e5f6a1b2\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mpython\u001b[22m \u001b[32m--version\u001b[39m=\u001b[2m1.0.0\u001b[22m \u001b[32m--publish-type\u001b[39m=\u001b[2mpackage\u001b[22m \u001b[32m--dry-run\u001b[39m",
|
|
691
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mpublish\u001b[22m \u001b[32m--profile-id\u001b[39m=\u001b[2md4e5f6a1b2c3d4e5f6a1b2c3\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mcsharp\u001b[22m \u001b[32m--version\u001b[39m=\u001b[2m1.0.0\u001b[22m \u001b[32m--publish-type\u001b[39m=\u001b[2mpackage\u001b[22m \u001b[32m--codegen-version\u001b[39m=\u001b[2mv4\u001b[22m \u001b[32m--stability\u001b[39m=\u001b[2mbeta\u001b[22m"
|
|
692
|
+
],
|
|
693
|
+
"flags": {
|
|
694
|
+
"profile-id": {
|
|
695
|
+
"char": "p",
|
|
696
|
+
"description": "Id of the publishing profile to use.",
|
|
697
|
+
"name": "profile-id",
|
|
698
|
+
"hasDynamicHelp": false,
|
|
699
|
+
"multiple": false,
|
|
700
|
+
"type": "option"
|
|
701
|
+
},
|
|
702
|
+
"version": {
|
|
703
|
+
"char": "v",
|
|
704
|
+
"description": "Semantic version of the SDK to publish (e.g. 1.0.0).",
|
|
705
|
+
"name": "version",
|
|
706
|
+
"hasDynamicHelp": false,
|
|
707
|
+
"multiple": false,
|
|
708
|
+
"type": "option"
|
|
709
|
+
},
|
|
710
|
+
"destination": {
|
|
711
|
+
"char": "d",
|
|
712
|
+
"description": "[default: <input>/sdk] path where the sdk will be generated.",
|
|
713
|
+
"name": "destination",
|
|
714
|
+
"hasDynamicHelp": false,
|
|
715
|
+
"multiple": false,
|
|
716
|
+
"type": "option"
|
|
717
|
+
},
|
|
718
|
+
"language": {
|
|
719
|
+
"char": "l",
|
|
720
|
+
"description": "Language of the SDK to generate and publish.",
|
|
721
|
+
"name": "language",
|
|
722
|
+
"hasDynamicHelp": false,
|
|
723
|
+
"multiple": false,
|
|
724
|
+
"options": [
|
|
725
|
+
"csharp",
|
|
726
|
+
"java",
|
|
727
|
+
"php",
|
|
728
|
+
"python",
|
|
729
|
+
"ruby",
|
|
730
|
+
"typescript"
|
|
731
|
+
],
|
|
732
|
+
"type": "option"
|
|
733
|
+
},
|
|
734
|
+
"force": {
|
|
735
|
+
"char": "f",
|
|
736
|
+
"description": "overwrite changes without asking for user consent.",
|
|
737
|
+
"name": "force",
|
|
738
|
+
"allowNo": false,
|
|
739
|
+
"type": "boolean"
|
|
740
|
+
},
|
|
741
|
+
"input": {
|
|
742
|
+
"char": "i",
|
|
743
|
+
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
744
|
+
"name": "input",
|
|
745
|
+
"hasDynamicHelp": false,
|
|
746
|
+
"multiple": false,
|
|
747
|
+
"type": "option"
|
|
748
|
+
},
|
|
749
|
+
"publish-type": {
|
|
750
|
+
"description": "One or more publishing targets: 'package' for a package registry, 'sourcecode' for a git repository.",
|
|
751
|
+
"name": "publish-type",
|
|
752
|
+
"hasDynamicHelp": false,
|
|
753
|
+
"multiple": true,
|
|
754
|
+
"options": [
|
|
755
|
+
"package",
|
|
756
|
+
"sourcecode"
|
|
757
|
+
],
|
|
758
|
+
"type": "option"
|
|
759
|
+
},
|
|
760
|
+
"dry-run": {
|
|
761
|
+
"description": "Generate the SDK locally for review without publishing.",
|
|
762
|
+
"name": "dry-run",
|
|
763
|
+
"allowNo": false,
|
|
764
|
+
"type": "boolean"
|
|
765
|
+
},
|
|
766
|
+
"codegen-version": {
|
|
767
|
+
"description": "Version of the code generator to use",
|
|
768
|
+
"name": "codegen-version",
|
|
769
|
+
"default": "v3",
|
|
770
|
+
"hasDynamicHelp": false,
|
|
771
|
+
"multiple": false,
|
|
772
|
+
"options": [
|
|
773
|
+
"v3",
|
|
774
|
+
"v4"
|
|
775
|
+
],
|
|
776
|
+
"type": "option"
|
|
777
|
+
},
|
|
778
|
+
"stability": {
|
|
779
|
+
"description": "Stability level of the generated SDK",
|
|
780
|
+
"name": "stability",
|
|
781
|
+
"default": "stable",
|
|
782
|
+
"hasDynamicHelp": false,
|
|
783
|
+
"multiple": false,
|
|
784
|
+
"options": [
|
|
785
|
+
"stable",
|
|
786
|
+
"beta"
|
|
787
|
+
],
|
|
788
|
+
"type": "option"
|
|
789
|
+
},
|
|
790
|
+
"update-plugin-config": {
|
|
791
|
+
"description": "Record the published SDK in 'plugin-config.json', creating the file if it does not exist. Interactive runs are asked instead.",
|
|
792
|
+
"name": "update-plugin-config",
|
|
793
|
+
"allowNo": false,
|
|
794
|
+
"type": "boolean"
|
|
795
|
+
}
|
|
796
|
+
},
|
|
797
|
+
"hasDynamicHelp": false,
|
|
798
|
+
"hiddenAliases": [],
|
|
799
|
+
"id": "sdk:publish",
|
|
800
|
+
"pluginAlias": "@apimatic/cli",
|
|
801
|
+
"pluginName": "@apimatic/cli",
|
|
802
|
+
"pluginType": "core",
|
|
803
|
+
"strict": true,
|
|
804
|
+
"summary": "Generate and publish an SDK to a package registry and/or source repository",
|
|
805
|
+
"enableJsonFlag": false,
|
|
806
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mpublish\u001b[22m",
|
|
807
|
+
"isESM": true,
|
|
808
|
+
"relativePath": [
|
|
809
|
+
"lib",
|
|
810
|
+
"commands",
|
|
811
|
+
"sdk",
|
|
812
|
+
"publish.js"
|
|
813
|
+
]
|
|
814
|
+
},
|
|
815
|
+
"sdk:save-changes": {
|
|
816
|
+
"aliases": [],
|
|
817
|
+
"args": {},
|
|
818
|
+
"description": "Requires an input directory with API specifications, a path to the updated SDK directory, and the programming language.",
|
|
819
|
+
"examples": [
|
|
820
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2msave-changes\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mcsharp\u001b[22m",
|
|
821
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2msave-changes\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mjava\u001b[22m \u001b[32m--sdk\u001b[39m=\u001b[2m./sdk\u001b[22m"
|
|
822
|
+
],
|
|
823
|
+
"flags": {
|
|
824
|
+
"language": {
|
|
825
|
+
"char": "l",
|
|
826
|
+
"description": "Programming language of the SDK",
|
|
827
|
+
"name": "language",
|
|
828
|
+
"required": true,
|
|
829
|
+
"hasDynamicHelp": false,
|
|
830
|
+
"multiple": false,
|
|
831
|
+
"options": [
|
|
832
|
+
"csharp",
|
|
833
|
+
"java",
|
|
834
|
+
"php",
|
|
835
|
+
"python",
|
|
836
|
+
"ruby",
|
|
837
|
+
"typescript",
|
|
838
|
+
"go"
|
|
839
|
+
],
|
|
840
|
+
"type": "option"
|
|
841
|
+
},
|
|
842
|
+
"sdk": {
|
|
843
|
+
"description": "[default: ./sdk/<language> | ./sdk/<api-version>/<language>] path to the folder containing the updated SDK.",
|
|
844
|
+
"name": "sdk",
|
|
845
|
+
"hasDynamicHelp": false,
|
|
846
|
+
"multiple": false,
|
|
847
|
+
"type": "option"
|
|
848
|
+
},
|
|
849
|
+
"api-version": {
|
|
850
|
+
"description": "Version of the API where changes should be saved (if multiple versions exist).",
|
|
851
|
+
"name": "api-version",
|
|
852
|
+
"hasDynamicHelp": false,
|
|
853
|
+
"multiple": false,
|
|
854
|
+
"type": "option"
|
|
855
|
+
},
|
|
856
|
+
"input": {
|
|
857
|
+
"char": "i",
|
|
858
|
+
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
859
|
+
"name": "input",
|
|
860
|
+
"hasDynamicHelp": false,
|
|
861
|
+
"multiple": false,
|
|
862
|
+
"type": "option"
|
|
863
|
+
}
|
|
864
|
+
},
|
|
865
|
+
"hasDynamicHelp": false,
|
|
866
|
+
"hiddenAliases": [],
|
|
867
|
+
"id": "sdk:save-changes",
|
|
868
|
+
"pluginAlias": "@apimatic/cli",
|
|
869
|
+
"pluginName": "@apimatic/cli",
|
|
870
|
+
"pluginType": "core",
|
|
871
|
+
"strict": true,
|
|
872
|
+
"summary": "Save customizations made to an auto-generated SDK",
|
|
873
|
+
"enableJsonFlag": false,
|
|
874
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2msave-changes\u001b[22m",
|
|
875
|
+
"isESM": true,
|
|
876
|
+
"relativePath": [
|
|
877
|
+
"lib",
|
|
878
|
+
"commands",
|
|
879
|
+
"sdk",
|
|
880
|
+
"save-changes.js"
|
|
881
|
+
]
|
|
882
|
+
},
|
|
883
|
+
"portal:recipe:new": {
|
|
884
|
+
"aliases": [],
|
|
885
|
+
"args": {},
|
|
886
|
+
"description": "This command adds a new API Recipe file to your documentation portal.\n\nTo learn more about API Recipes, visit:\n\u001b[4m\u001b[94mhttps://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/api-recipes\u001b[39m\u001b[24m",
|
|
887
|
+
"examples": [
|
|
888
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mrecipe\u001b[22m \u001b[2mnew\u001b[22m",
|
|
889
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mrecipe\u001b[22m \u001b[2mnew\u001b[22m \u001b[32m--name\u001b[39m=\u001b[2m'\"My API Recipe\"'\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m\"./\"\u001b[22m"
|
|
890
|
+
],
|
|
891
|
+
"flags": {
|
|
892
|
+
"name": {
|
|
893
|
+
"description": "name for the recipe",
|
|
894
|
+
"name": "name",
|
|
895
|
+
"hasDynamicHelp": false,
|
|
896
|
+
"multiple": false,
|
|
897
|
+
"type": "option"
|
|
898
|
+
},
|
|
899
|
+
"input": {
|
|
900
|
+
"char": "i",
|
|
901
|
+
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
902
|
+
"name": "input",
|
|
903
|
+
"hasDynamicHelp": false,
|
|
904
|
+
"multiple": false,
|
|
905
|
+
"type": "option"
|
|
906
|
+
},
|
|
907
|
+
"force": {
|
|
908
|
+
"char": "f",
|
|
909
|
+
"description": "overwrite changes without asking for user consent.",
|
|
910
|
+
"name": "force",
|
|
911
|
+
"allowNo": false,
|
|
912
|
+
"type": "boolean"
|
|
913
|
+
}
|
|
914
|
+
},
|
|
915
|
+
"hasDynamicHelp": false,
|
|
916
|
+
"hiddenAliases": [],
|
|
917
|
+
"id": "portal:recipe:new",
|
|
918
|
+
"pluginAlias": "@apimatic/cli",
|
|
919
|
+
"pluginName": "@apimatic/cli",
|
|
920
|
+
"pluginType": "core",
|
|
921
|
+
"strict": true,
|
|
922
|
+
"summary": "Add an API Recipe to your API documentation portal.",
|
|
923
|
+
"enableJsonFlag": false,
|
|
924
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mrecipe\u001b[22m \u001b[2mnew\u001b[22m",
|
|
925
|
+
"isESM": true,
|
|
926
|
+
"relativePath": [
|
|
927
|
+
"lib",
|
|
928
|
+
"commands",
|
|
929
|
+
"portal",
|
|
930
|
+
"recipe",
|
|
931
|
+
"new.js"
|
|
932
|
+
]
|
|
933
|
+
},
|
|
934
|
+
"publishing:profile:list": {
|
|
935
|
+
"aliases": [],
|
|
936
|
+
"args": {},
|
|
937
|
+
"description": "Display all publishing profiles associated with your account, including each profile's name, ID and enabled languages.",
|
|
938
|
+
"examples": [
|
|
939
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mpublishing\u001b[22m \u001b[2mprofile\u001b[22m \u001b[2mlist\u001b[22m"
|
|
940
|
+
],
|
|
941
|
+
"flags": {},
|
|
942
|
+
"hasDynamicHelp": false,
|
|
943
|
+
"hiddenAliases": [],
|
|
944
|
+
"id": "publishing:profile:list",
|
|
945
|
+
"pluginAlias": "@apimatic/cli",
|
|
946
|
+
"pluginName": "@apimatic/cli",
|
|
947
|
+
"pluginType": "core",
|
|
948
|
+
"strict": true,
|
|
949
|
+
"summary": "List all publishing profiles",
|
|
950
|
+
"enableJsonFlag": false,
|
|
951
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mpublishing\u001b[22m \u001b[2mprofile\u001b[22m \u001b[2mlist\u001b[22m",
|
|
952
|
+
"isESM": true,
|
|
953
|
+
"relativePath": [
|
|
954
|
+
"lib",
|
|
955
|
+
"commands",
|
|
956
|
+
"publishing",
|
|
957
|
+
"profile",
|
|
958
|
+
"list.js"
|
|
959
|
+
]
|
|
960
|
+
},
|
|
961
|
+
"portal:toc:new": {
|
|
962
|
+
"aliases": [],
|
|
963
|
+
"args": {},
|
|
964
|
+
"description": "This command generates a new Table of Contents (TOC) file used in the\ngeneration of your API documentation portal.\n\nThe output is a YAML file with the .yml extension.\n\nTo learn more about the TOC file and APIMatic build directory structure, visit:\n\u001b[4m\u001b[94mhttps://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/overview-generating-api-portal\u001b[39m\u001b[24m",
|
|
965
|
+
"examples": [
|
|
966
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mtoc\u001b[22m \u001b[2mnew\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m./src/content/\u001b[22m",
|
|
967
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mtoc\u001b[22m \u001b[2mnew\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m./\u001b[22m",
|
|
968
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mtoc\u001b[22m \u001b[2mnew\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m./\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m./src/content/\u001b[22m"
|
|
969
|
+
],
|
|
970
|
+
"flags": {
|
|
971
|
+
"destination": {
|
|
972
|
+
"char": "d",
|
|
973
|
+
"description": "[default: <input>/src/content] path where the toc.yml will be generated.",
|
|
974
|
+
"name": "destination",
|
|
975
|
+
"hasDynamicHelp": false,
|
|
976
|
+
"multiple": false,
|
|
977
|
+
"type": "option"
|
|
978
|
+
},
|
|
979
|
+
"input": {
|
|
980
|
+
"char": "i",
|
|
981
|
+
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
982
|
+
"name": "input",
|
|
983
|
+
"hasDynamicHelp": false,
|
|
984
|
+
"multiple": false,
|
|
985
|
+
"type": "option"
|
|
986
|
+
},
|
|
987
|
+
"force": {
|
|
988
|
+
"char": "f",
|
|
989
|
+
"description": "overwrite changes without asking for user consent.",
|
|
990
|
+
"name": "force",
|
|
991
|
+
"allowNo": false,
|
|
992
|
+
"type": "boolean"
|
|
993
|
+
},
|
|
994
|
+
"expand-endpoints": {
|
|
995
|
+
"description": "include individual entries for each endpoint in the generated \u001b[35m'toc.yml'\u001b[39m. Requires a valid API specification in the working directory.",
|
|
996
|
+
"name": "expand-endpoints",
|
|
997
|
+
"allowNo": false,
|
|
998
|
+
"type": "boolean"
|
|
999
|
+
},
|
|
1000
|
+
"expand-models": {
|
|
1001
|
+
"description": "include individual entries for each model in the generated \u001b[35m'toc.yml'\u001b[39m. Requires a valid API specification in the working directory.",
|
|
1002
|
+
"name": "expand-models",
|
|
1003
|
+
"allowNo": false,
|
|
1004
|
+
"type": "boolean"
|
|
1005
|
+
},
|
|
1006
|
+
"expand-webhooks": {
|
|
1007
|
+
"description": "include individual entries for each webhook in the generated \u001b[35m'toc.yml'\u001b[39m. Requires a valid API specification in the working directory.",
|
|
1008
|
+
"name": "expand-webhooks",
|
|
1009
|
+
"allowNo": false,
|
|
1010
|
+
"type": "boolean"
|
|
1011
|
+
},
|
|
1012
|
+
"expand-callbacks": {
|
|
1013
|
+
"description": "include individual entries for each callback in the generated \u001b[35m'toc.yml'\u001b[39m. Requires a valid API specification in the working directory.",
|
|
1014
|
+
"name": "expand-callbacks",
|
|
1015
|
+
"allowNo": false,
|
|
1016
|
+
"type": "boolean"
|
|
1017
|
+
}
|
|
1018
|
+
},
|
|
1019
|
+
"hasDynamicHelp": false,
|
|
1020
|
+
"hiddenAliases": [],
|
|
1021
|
+
"id": "portal:toc:new",
|
|
1022
|
+
"pluginAlias": "@apimatic/cli",
|
|
1023
|
+
"pluginName": "@apimatic/cli",
|
|
1024
|
+
"pluginType": "core",
|
|
1025
|
+
"strict": true,
|
|
1026
|
+
"summary": "Generate a Table of Contents (TOC) file for your API documentation portal",
|
|
1027
|
+
"enableJsonFlag": false,
|
|
1028
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mtoc\u001b[22m \u001b[2mnew\u001b[22m",
|
|
1029
|
+
"isESM": true,
|
|
1030
|
+
"relativePath": [
|
|
1031
|
+
"lib",
|
|
1032
|
+
"commands",
|
|
1033
|
+
"portal",
|
|
1034
|
+
"toc",
|
|
1035
|
+
"new.js"
|
|
1036
|
+
]
|
|
1037
|
+
}
|
|
1038
|
+
},
|
|
1039
|
+
"version": "1.3.0-beta.2"
|
|
1040
|
+
}
|