@apimatic/cli 1.4.0 → 2.0.0-beta.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.
Files changed (610) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +128 -212
  3. package/apimatic.schema.json +550 -0
  4. package/lib/actions/action-result.js +3 -0
  5. package/lib/actions/action-result.js.map +1 -1
  6. package/lib/actions/api/transform.js +36 -33
  7. package/lib/actions/api/transform.js.map +1 -1
  8. package/lib/actions/api/validate.d.ts +9 -6
  9. package/lib/actions/api/validate.js +44 -38
  10. package/lib/actions/api/validate.js.map +1 -1
  11. package/lib/actions/auth/login.js +7 -4
  12. package/lib/actions/auth/login.js.map +1 -1
  13. package/lib/actions/auth/logout.js +2 -1
  14. package/lib/actions/auth/logout.js.map +1 -1
  15. package/lib/actions/auth/status.js +5 -3
  16. package/lib/actions/auth/status.js.map +1 -1
  17. package/lib/actions/plugin/generate.d.ts +5 -1
  18. package/lib/actions/plugin/generate.js +83 -56
  19. package/lib/actions/plugin/generate.js.map +1 -1
  20. package/lib/actions/plugin/publish.d.ts +2 -1
  21. package/lib/actions/plugin/publish.js +34 -37
  22. package/lib/actions/plugin/publish.js.map +1 -1
  23. package/lib/actions/plugin/record-metadata.d.ts +3 -2
  24. package/lib/actions/plugin/record-metadata.js +33 -30
  25. package/lib/actions/plugin/record-metadata.js.map +1 -1
  26. package/lib/actions/portal/generate.d.ts +8 -6
  27. package/lib/actions/portal/generate.js +50 -61
  28. package/lib/actions/portal/generate.js.map +1 -1
  29. package/lib/actions/portal/prepare-project.d.ts +25 -0
  30. package/lib/actions/portal/prepare-project.js +68 -0
  31. package/lib/actions/portal/prepare-project.js.map +1 -0
  32. package/lib/actions/portal/serve.d.ts +21 -6
  33. package/lib/actions/portal/serve.js +170 -153
  34. package/lib/actions/portal/serve.js.map +1 -1
  35. package/lib/actions/publishing/profile/list.js +4 -2
  36. package/lib/actions/publishing/profile/list.js.map +1 -1
  37. package/lib/actions/quickstart.d.ts +23 -5
  38. package/lib/actions/quickstart.js +222 -21
  39. package/lib/actions/quickstart.js.map +1 -1
  40. package/lib/actions/sdk/generate.d.ts +4 -7
  41. package/lib/actions/sdk/generate.js +53 -93
  42. package/lib/actions/sdk/generate.js.map +1 -1
  43. package/lib/actions/sdk/publish/interactive.d.ts +4 -3
  44. package/lib/actions/sdk/publish/interactive.js +96 -97
  45. package/lib/actions/sdk/publish/interactive.js.map +1 -1
  46. package/lib/actions/sdk/publish/non-interactive.d.ts +4 -2
  47. package/lib/actions/sdk/publish/non-interactive.js +91 -90
  48. package/lib/actions/sdk/publish/non-interactive.js.map +1 -1
  49. package/lib/actions/sdk/publish.d.ts +3 -2
  50. package/lib/actions/sdk/publish.js +55 -53
  51. package/lib/actions/sdk/publish.js.map +1 -1
  52. package/lib/actions/sdk/record-published-sdk.d.ts +14 -0
  53. package/lib/actions/sdk/record-published-sdk.js +57 -0
  54. package/lib/actions/sdk/record-published-sdk.js.map +1 -0
  55. package/lib/client-utils/auth-manager.js +1 -1
  56. package/lib/client-utils/auth-manager.js.map +1 -1
  57. package/lib/commands/api/transform.d.ts +1 -1
  58. package/lib/commands/api/transform.js +44 -40
  59. package/lib/commands/api/transform.js.map +1 -1
  60. package/lib/commands/api/validate.js +16 -16
  61. package/lib/commands/api/validate.js.map +1 -1
  62. package/lib/commands/auth/login.js +14 -15
  63. package/lib/commands/auth/login.js.map +1 -1
  64. package/lib/commands/auth/logout.js +5 -6
  65. package/lib/commands/auth/logout.js.map +1 -1
  66. package/lib/commands/auth/status.js +4 -5
  67. package/lib/commands/auth/status.js.map +1 -1
  68. package/lib/commands/plugin/generate.d.ts +3 -3
  69. package/lib/commands/plugin/generate.js +20 -20
  70. package/lib/commands/plugin/generate.js.map +1 -1
  71. package/lib/commands/plugin/publish.js +18 -18
  72. package/lib/commands/plugin/publish.js.map +1 -1
  73. package/lib/commands/portal/generate.d.ts +9 -8
  74. package/lib/commands/portal/generate.js +36 -27
  75. package/lib/commands/portal/generate.js.map +1 -1
  76. package/lib/commands/portal/serve.d.ts +7 -9
  77. package/lib/commands/portal/serve.js +41 -44
  78. package/lib/commands/portal/serve.js.map +1 -1
  79. package/lib/commands/publishing/profile/list.js +8 -12
  80. package/lib/commands/publishing/profile/list.js.map +1 -1
  81. package/lib/commands/quickstart.d.ts +5 -5
  82. package/lib/commands/quickstart.js +18 -24
  83. package/lib/commands/quickstart.js.map +1 -1
  84. package/lib/commands/sdk/generate.d.ts +5 -7
  85. package/lib/commands/sdk/generate.js +58 -70
  86. package/lib/commands/sdk/generate.js.map +1 -1
  87. package/lib/commands/sdk/publish.d.ts +6 -7
  88. package/lib/commands/sdk/publish.js +66 -60
  89. package/lib/commands/sdk/publish.js.map +1 -1
  90. package/lib/hooks/node-version.d.ts +3 -0
  91. package/lib/hooks/node-version.js +12 -0
  92. package/lib/hooks/node-version.js.map +1 -0
  93. package/lib/hooks/not-found.js +2 -3
  94. package/lib/hooks/not-found.js.map +1 -1
  95. package/lib/hooks/utils.d.ts +4 -2
  96. package/lib/hooks/utils.js +2 -2
  97. package/lib/hooks/utils.js.map +1 -1
  98. package/lib/infrastructure/env-info.d.ts +3 -0
  99. package/lib/infrastructure/env-info.js +13 -6
  100. package/lib/infrastructure/env-info.js.map +1 -1
  101. package/lib/infrastructure/file-service.d.ts +35 -8
  102. package/lib/infrastructure/file-service.js +149 -53
  103. package/lib/infrastructure/file-service.js.map +1 -1
  104. package/lib/infrastructure/file-watch-service.d.ts +40 -0
  105. package/lib/infrastructure/file-watch-service.js +167 -0
  106. package/lib/infrastructure/file-watch-service.js.map +1 -0
  107. package/lib/infrastructure/generation-status-poller.d.ts +8 -7
  108. package/lib/infrastructure/generation-status-poller.js +20 -12
  109. package/lib/infrastructure/generation-status-poller.js.map +1 -1
  110. package/lib/infrastructure/launcher-service.js +6 -6
  111. package/lib/infrastructure/launcher-service.js.map +1 -1
  112. package/lib/infrastructure/network-service.d.ts +3 -0
  113. package/lib/infrastructure/network-service.js +15 -1
  114. package/lib/infrastructure/network-service.js.map +1 -1
  115. package/lib/infrastructure/portal-build-service.d.ts +19 -0
  116. package/lib/infrastructure/portal-build-service.js +58 -0
  117. package/lib/infrastructure/portal-build-service.js.map +1 -0
  118. package/lib/infrastructure/portal-dev-server-service.d.ts +29 -0
  119. package/lib/infrastructure/portal-dev-server-service.js +135 -0
  120. package/lib/infrastructure/portal-dev-server-service.js.map +1 -0
  121. package/lib/infrastructure/portal-pages-service.d.ts +17 -0
  122. package/lib/infrastructure/portal-pages-service.js +103 -0
  123. package/lib/infrastructure/portal-pages-service.js.map +1 -0
  124. package/lib/infrastructure/portal-project-service.d.ts +77 -0
  125. package/lib/infrastructure/portal-project-service.js +309 -0
  126. package/lib/infrastructure/portal-project-service.js.map +1 -0
  127. package/lib/infrastructure/service-error.d.ts +1 -0
  128. package/lib/infrastructure/service-error.js +39 -41
  129. package/lib/infrastructure/service-error.js.map +1 -1
  130. package/lib/infrastructure/services/api-client-factory.js +15 -13
  131. package/lib/infrastructure/services/api-client-factory.js.map +1 -1
  132. package/lib/infrastructure/services/api-service.d.ts +7 -5
  133. package/lib/infrastructure/services/api-service.js +28 -20
  134. package/lib/infrastructure/services/api-service.js.map +1 -1
  135. package/lib/infrastructure/services/auth-service.js +4 -9
  136. package/lib/infrastructure/services/auth-service.js.map +1 -1
  137. package/lib/infrastructure/services/file-download-service.js +3 -3
  138. package/lib/infrastructure/services/file-download-service.js.map +1 -1
  139. package/lib/infrastructure/services/plugin-service.d.ts +1 -8
  140. package/lib/infrastructure/services/plugin-service.js +11 -22
  141. package/lib/infrastructure/services/plugin-service.js.map +1 -1
  142. package/lib/infrastructure/services/portal-artifacts-service.d.ts +44 -0
  143. package/lib/infrastructure/services/portal-artifacts-service.js +268 -0
  144. package/lib/infrastructure/services/portal-artifacts-service.js.map +1 -0
  145. package/lib/infrastructure/services/portal-authorization-service.d.ts +22 -0
  146. package/lib/infrastructure/services/portal-authorization-service.js +23 -0
  147. package/lib/infrastructure/services/portal-authorization-service.js.map +1 -0
  148. package/lib/infrastructure/services/publishing-api-service.d.ts +1 -1
  149. package/lib/infrastructure/services/publishing-api-service.js +11 -15
  150. package/lib/infrastructure/services/publishing-api-service.js.map +1 -1
  151. package/lib/infrastructure/services/sdk-generation-service.d.ts +21 -0
  152. package/lib/infrastructure/services/sdk-generation-service.js +118 -0
  153. package/lib/infrastructure/services/sdk-generation-service.js.map +1 -0
  154. package/lib/infrastructure/services/telemetry-service.js +5 -4
  155. package/lib/infrastructure/services/telemetry-service.js.map +1 -1
  156. package/lib/infrastructure/services/transformation-service.js +29 -32
  157. package/lib/infrastructure/services/transformation-service.js.map +1 -1
  158. package/lib/infrastructure/services/validation-service.d.ts +12 -53
  159. package/lib/infrastructure/services/validation-service.js +24 -199
  160. package/lib/infrastructure/services/validation-service.js.map +1 -1
  161. package/lib/infrastructure/timer-extensions.d.ts +2 -0
  162. package/lib/infrastructure/timer-extensions.js +10 -0
  163. package/lib/infrastructure/timer-extensions.js.map +1 -0
  164. package/lib/infrastructure/tmp-extensions.d.ts +31 -1
  165. package/lib/infrastructure/tmp-extensions.js +86 -3
  166. package/lib/infrastructure/tmp-extensions.js.map +1 -1
  167. package/lib/infrastructure/zip-service.js +2 -2
  168. package/lib/infrastructure/zip-service.js.map +1 -1
  169. package/lib/prompts/api/validate.d.ts +6 -7
  170. package/lib/prompts/api/validate.js +12 -12
  171. package/lib/prompts/api/validate.js.map +1 -1
  172. package/lib/prompts/format.d.ts +4 -0
  173. package/lib/prompts/format.js +5 -0
  174. package/lib/prompts/format.js.map +1 -1
  175. package/lib/prompts/plugin/generate.d.ts +17 -12
  176. package/lib/prompts/plugin/generate.js +94 -44
  177. package/lib/prompts/plugin/generate.js.map +1 -1
  178. package/lib/prompts/plugin/publish.d.ts +2 -1
  179. package/lib/prompts/plugin/publish.js +8 -7
  180. package/lib/prompts/plugin/publish.js.map +1 -1
  181. package/lib/prompts/plugin/record-metadata.d.ts +1 -0
  182. package/lib/prompts/plugin/record-metadata.js +10 -7
  183. package/lib/prompts/plugin/record-metadata.js.map +1 -1
  184. package/lib/prompts/portal/artifacts.d.ts +8 -0
  185. package/lib/prompts/portal/artifacts.js +26 -0
  186. package/lib/prompts/portal/artifacts.js.map +1 -0
  187. package/lib/prompts/portal/authorization.d.ts +6 -0
  188. package/lib/prompts/portal/authorization.js +29 -0
  189. package/lib/prompts/portal/authorization.js.map +1 -0
  190. package/lib/prompts/portal/code-samples.d.ts +1 -0
  191. package/lib/prompts/portal/code-samples.js +9 -0
  192. package/lib/prompts/portal/code-samples.js.map +1 -0
  193. package/lib/prompts/portal/generate.d.ts +14 -9
  194. package/lib/prompts/portal/generate.js +48 -26
  195. package/lib/prompts/portal/generate.js.map +1 -1
  196. package/lib/prompts/portal/prepare-project.d.ts +20 -0
  197. package/lib/prompts/portal/prepare-project.js +36 -0
  198. package/lib/prompts/portal/prepare-project.js.map +1 -0
  199. package/lib/prompts/portal/serve.d.ts +32 -12
  200. package/lib/prompts/portal/serve.js +102 -39
  201. package/lib/prompts/portal/serve.js.map +1 -1
  202. package/lib/prompts/portal/source.d.ts +26 -0
  203. package/lib/prompts/portal/source.js +253 -0
  204. package/lib/prompts/portal/source.js.map +1 -0
  205. package/lib/prompts/prompt.d.ts +11 -3
  206. package/lib/prompts/prompt.js +39 -15
  207. package/lib/prompts/prompt.js.map +1 -1
  208. package/lib/prompts/quickstart.d.ts +46 -3
  209. package/lib/prompts/quickstart.js +199 -12
  210. package/lib/prompts/quickstart.js.map +1 -1
  211. package/lib/prompts/sdk/generate.d.ts +15 -13
  212. package/lib/prompts/sdk/generate.js +29 -32
  213. package/lib/prompts/sdk/generate.js.map +1 -1
  214. package/lib/prompts/sdk/publish/interactive.d.ts +10 -6
  215. package/lib/prompts/sdk/publish/interactive.js +26 -24
  216. package/lib/prompts/sdk/publish/interactive.js.map +1 -1
  217. package/lib/prompts/sdk/publish/non-interactive.d.ts +2 -1
  218. package/lib/prompts/sdk/publish/non-interactive.js +5 -4
  219. package/lib/prompts/sdk/publish/non-interactive.js.map +1 -1
  220. package/lib/prompts/sdk/publish.d.ts +3 -3
  221. package/lib/prompts/sdk/publish.js +13 -17
  222. package/lib/prompts/sdk/publish.js.map +1 -1
  223. package/lib/prompts/sdk/record-published-sdk.d.ts +7 -0
  224. package/lib/prompts/sdk/record-published-sdk.js +26 -0
  225. package/lib/prompts/sdk/record-published-sdk.js.map +1 -0
  226. package/lib/types/apimatic-config/document.d.ts +70 -0
  227. package/lib/types/apimatic-config/document.js +167 -0
  228. package/lib/types/apimatic-config/document.js.map +1 -0
  229. package/lib/types/apimatic-config/languages-block.d.ts +39 -0
  230. package/lib/types/apimatic-config/languages-block.js +58 -0
  231. package/lib/types/apimatic-config/languages-block.js.map +1 -0
  232. package/lib/types/apimatic-config-context.d.ts +48 -0
  233. package/lib/types/apimatic-config-context.js +121 -0
  234. package/lib/types/apimatic-config-context.js.map +1 -0
  235. package/lib/types/build/build.d.ts +1 -89
  236. package/lib/types/build/build.js +6 -161
  237. package/lib/types/build/build.js.map +1 -1
  238. package/lib/types/events/domain-event.js +3 -0
  239. package/lib/types/events/domain-event.js.map +1 -1
  240. package/lib/types/events/quickstart-completed.js +3 -3
  241. package/lib/types/events/quickstart-completed.js.map +1 -1
  242. package/lib/types/events/quickstart-initiated.js +3 -3
  243. package/lib/types/events/quickstart-initiated.js.map +1 -1
  244. package/lib/types/events/sdk-publish-validation-failed.js +1 -1
  245. package/lib/types/events/sdk-publish-validation-failed.js.map +1 -1
  246. package/lib/types/file/directory.d.ts +4 -9
  247. package/lib/types/file/directory.js +17 -65
  248. package/lib/types/file/directory.js.map +1 -1
  249. package/lib/types/file/directoryPath.d.ts +17 -0
  250. package/lib/types/file/directoryPath.js +47 -2
  251. package/lib/types/file/directoryPath.js.map +1 -1
  252. package/lib/types/file/fileName.d.ts +8 -0
  253. package/lib/types/file/fileName.js +28 -6
  254. package/lib/types/file/fileName.js.map +1 -1
  255. package/lib/types/file/filePath.d.ts +18 -2
  256. package/lib/types/file/filePath.js +39 -4
  257. package/lib/types/file/filePath.js.map +1 -1
  258. package/lib/types/file/resource-input.js +1 -2
  259. package/lib/types/file/resource-input.js.map +1 -1
  260. package/lib/types/file/urlPath.js +2 -1
  261. package/lib/types/file/urlPath.js.map +1 -1
  262. package/lib/types/flags-provider.js +22 -22
  263. package/lib/types/flags-provider.js.map +1 -1
  264. package/lib/types/package-settings-context.js +2 -1
  265. package/lib/types/package-settings-context.js.map +1 -1
  266. package/lib/types/plugin/plugin-config.d.ts +10 -50
  267. package/lib/types/plugin/plugin-config.js +7 -1
  268. package/lib/types/plugin/plugin-config.js.map +1 -1
  269. package/lib/types/plugin-config-context.d.ts +30 -37
  270. package/lib/types/plugin-config-context.js +108 -139
  271. package/lib/types/plugin-config-context.js.map +1 -1
  272. package/lib/types/plugin-context.js +3 -2
  273. package/lib/types/plugin-context.js.map +1 -1
  274. package/lib/types/portal/code-samples.d.ts +27 -0
  275. package/lib/types/portal/code-samples.js +67 -0
  276. package/lib/types/portal/code-samples.js.map +1 -0
  277. package/lib/types/portal/config/ai-config.d.ts +15 -0
  278. package/lib/types/portal/config/ai-config.js +26 -0
  279. package/lib/types/portal/config/ai-config.js.map +1 -0
  280. package/lib/types/portal/config/brand-config.d.ts +55 -0
  281. package/lib/types/portal/config/brand-config.js +105 -0
  282. package/lib/types/portal/config/brand-config.js.map +1 -0
  283. package/lib/types/portal/config/color.d.ts +19 -0
  284. package/lib/types/portal/config/color.js +43 -0
  285. package/lib/types/portal/config/color.js.map +1 -0
  286. package/lib/types/portal/config/fields.d.ts +23 -0
  287. package/lib/types/portal/config/fields.js +67 -0
  288. package/lib/types/portal/config/fields.js.map +1 -0
  289. package/lib/types/portal/config/link.d.ts +18 -0
  290. package/lib/types/portal/config/link.js +72 -0
  291. package/lib/types/portal/config/link.js.map +1 -0
  292. package/lib/types/portal/config/navigation-config.d.ts +13 -0
  293. package/lib/types/portal/config/navigation-config.js +30 -0
  294. package/lib/types/portal/config/navigation-config.js.map +1 -0
  295. package/lib/types/portal/config/site-config.d.ts +32 -0
  296. package/lib/types/portal/config/site-config.js +88 -0
  297. package/lib/types/portal/config/site-config.js.map +1 -0
  298. package/lib/types/portal/config/static-asset.d.ts +25 -0
  299. package/lib/types/portal/config/static-asset.js +77 -0
  300. package/lib/types/portal/config/static-asset.js.map +1 -0
  301. package/lib/types/portal/content-notices.d.ts +20 -0
  302. package/lib/types/portal/content-notices.js +2 -0
  303. package/lib/types/portal/content-notices.js.map +1 -0
  304. package/lib/types/portal/content-tree.d.ts +103 -0
  305. package/lib/types/portal/content-tree.js +344 -0
  306. package/lib/types/portal/content-tree.js.map +1 -0
  307. package/lib/types/portal/endpoint.d.ts +6 -0
  308. package/lib/types/portal/endpoint.js +12 -0
  309. package/lib/types/portal/endpoint.js.map +1 -0
  310. package/lib/types/portal/generated-pages.d.ts +68 -0
  311. package/lib/types/portal/generated-pages.js +111 -0
  312. package/lib/types/portal/generated-pages.js.map +1 -0
  313. package/lib/types/portal/generation-status.d.ts +31 -0
  314. package/lib/types/portal/generation-status.js +26 -0
  315. package/lib/types/portal/generation-status.js.map +1 -0
  316. package/lib/types/portal/openapi-document.d.ts +48 -0
  317. package/lib/types/portal/openapi-document.js +138 -0
  318. package/lib/types/portal/openapi-document.js.map +1 -0
  319. package/lib/types/portal/page-fragments.d.ts +13 -0
  320. package/lib/types/portal/page-fragments.js +24 -0
  321. package/lib/types/portal/page-fragments.js.map +1 -0
  322. package/lib/types/portal/page-template.d.ts +15 -0
  323. package/lib/types/portal/page-template.js +64 -0
  324. package/lib/types/portal/page-template.js.map +1 -0
  325. package/lib/types/portal/page.d.ts +24 -0
  326. package/lib/types/portal/page.js +100 -0
  327. package/lib/types/portal/page.js.map +1 -0
  328. package/lib/types/portal/portal-artifacts.d.ts +25 -0
  329. package/lib/types/portal/portal-artifacts.js +30 -0
  330. package/lib/types/portal/portal-artifacts.js.map +1 -0
  331. package/lib/types/portal/portal-config.d.ts +69 -0
  332. package/lib/types/portal/portal-config.js +105 -0
  333. package/lib/types/portal/portal-config.js.map +1 -0
  334. package/lib/types/portal/portal-downloads.d.ts +8 -0
  335. package/lib/types/portal/portal-downloads.js +14 -0
  336. package/lib/types/portal/portal-downloads.js.map +1 -0
  337. package/lib/types/portal/portal-languages.d.ts +15 -0
  338. package/lib/types/portal/portal-languages.js +45 -0
  339. package/lib/types/portal/portal-languages.js.map +1 -0
  340. package/lib/types/portal/portal-navigation.d.ts +65 -0
  341. package/lib/types/portal/portal-navigation.js +217 -0
  342. package/lib/types/portal/portal-navigation.js.map +1 -0
  343. package/lib/types/portal/portal-sdk.d.ts +15 -0
  344. package/lib/types/portal/portal-sdk.js +28 -0
  345. package/lib/types/portal/portal-sdk.js.map +1 -0
  346. package/lib/types/portal/portal-source.d.ts +129 -0
  347. package/lib/types/portal/portal-source.js +2 -0
  348. package/lib/types/portal/portal-source.js.map +1 -0
  349. package/lib/types/portal/portal-stylesheet.d.ts +19 -0
  350. package/lib/types/portal/portal-stylesheet.js +40 -0
  351. package/lib/types/portal/portal-stylesheet.js.map +1 -0
  352. package/lib/types/portal/portal-tabs.d.ts +33 -0
  353. package/lib/types/portal/portal-tabs.js +38 -0
  354. package/lib/types/portal/portal-tabs.js.map +1 -0
  355. package/lib/types/portal/preview-config.d.ts +20 -0
  356. package/lib/types/portal/preview-config.js +32 -0
  357. package/lib/types/portal/preview-config.js.map +1 -0
  358. package/lib/types/portal/preview-content.d.ts +18 -0
  359. package/lib/types/portal/preview-content.js +50 -0
  360. package/lib/types/portal/preview-content.js.map +1 -0
  361. package/lib/types/portal/published-package.d.ts +12 -0
  362. package/lib/types/portal/published-package.js +35 -0
  363. package/lib/types/portal/published-package.js.map +1 -0
  364. package/lib/types/portal/unknown-fields.d.ts +5 -0
  365. package/lib/types/portal/unknown-fields.js +10 -0
  366. package/lib/types/portal/unknown-fields.js.map +1 -0
  367. package/lib/types/portal-context.d.ts +38 -6
  368. package/lib/types/portal-context.js +71 -24
  369. package/lib/types/portal-context.js.map +1 -1
  370. package/lib/types/portal-source-context.d.ts +77 -0
  371. package/lib/types/portal-source-context.js +408 -0
  372. package/lib/types/portal-source-context.js.map +1 -0
  373. package/lib/types/project-context.d.ts +49 -0
  374. package/lib/types/project-context.js +151 -0
  375. package/lib/types/project-context.js.map +1 -0
  376. package/lib/types/project-layout.d.ts +9 -0
  377. package/lib/types/project-layout.js +10 -0
  378. package/lib/types/project-layout.js.map +1 -0
  379. package/lib/types/publish/package-settings-configuration.d.ts +2 -0
  380. package/lib/types/publish/profile-id.js +1 -0
  381. package/lib/types/publish/profile-id.js.map +1 -1
  382. package/lib/types/publish/publishing-profile.d.ts +3 -1
  383. package/lib/types/publish/publishing-profile.js +33 -15
  384. package/lib/types/publish/publishing-profile.js.map +1 -1
  385. package/lib/types/publish/publishing-profiles.js +2 -1
  386. package/lib/types/publish/publishing-profiles.js.map +1 -1
  387. package/lib/types/publish/version.js +1 -0
  388. package/lib/types/publish/version.js.map +1 -1
  389. package/lib/types/resource-context.js +3 -2
  390. package/lib/types/resource-context.js.map +1 -1
  391. package/lib/types/sdk/generate.d.ts +22 -16
  392. package/lib/types/sdk/generate.js +64 -41
  393. package/lib/types/sdk/generate.js.map +1 -1
  394. package/lib/types/sdk/stability-choice.d.ts +12 -0
  395. package/lib/types/sdk/stability-choice.js +24 -0
  396. package/lib/types/sdk/stability-choice.js.map +1 -0
  397. package/lib/types/sdk-context.d.ts +4 -5
  398. package/lib/types/sdk-context.js +10 -18
  399. package/lib/types/sdk-context.js.map +1 -1
  400. package/lib/types/spec-context.d.ts +5 -4
  401. package/lib/types/spec-context.js +9 -8
  402. package/lib/types/spec-context.js.map +1 -1
  403. package/lib/types/temp-context.d.ts +1 -1
  404. package/lib/types/temp-context.js +5 -4
  405. package/lib/types/temp-context.js.map +1 -1
  406. package/lib/types/transform-context.d.ts +9 -5
  407. package/lib/types/transform-context.js +21 -18
  408. package/lib/types/transform-context.js.map +1 -1
  409. package/lib/utils/error-utils.d.ts +2 -0
  410. package/lib/utils/error-utils.js +5 -0
  411. package/lib/utils/error-utils.js.map +1 -0
  412. package/lib/utils/json-utils.d.ts +2 -0
  413. package/lib/utils/json-utils.js +4 -0
  414. package/lib/utils/json-utils.js.map +1 -0
  415. package/lib/utils/string-utils.d.ts +8 -1
  416. package/lib/utils/string-utils.js +13 -26
  417. package/lib/utils/string-utils.js.map +1 -1
  418. package/lib/utils/utils.d.ts +1 -3
  419. package/lib/utils/utils.js +12 -40
  420. package/lib/utils/utils.js.map +1 -1
  421. package/oclif.manifest.json +69 -357
  422. package/package.json +47 -25
  423. package/portal-pages/context-plugin.mdx +26 -0
  424. package/portal-pages/sdk.mdx +8 -0
  425. package/portal-pages/sdks.mdx +11 -0
  426. package/portal-template/NOTICE +37 -0
  427. package/portal-template/downloads.ts +41 -0
  428. package/portal-template/generated-pages-reload.ts +51 -0
  429. package/portal-template/package.json +11 -0
  430. package/portal-template/portal-config.ts +32 -0
  431. package/portal-template/prerender-pages.ts +81 -0
  432. package/portal-template/spec-reload.ts +26 -0
  433. package/portal-template/src/components/api-page.tsx +15 -0
  434. package/portal-template/src/components/code-block.tsx +9 -0
  435. package/portal-template/src/components/command-block.tsx +50 -0
  436. package/portal-template/src/components/example-layout.tsx +99 -0
  437. package/portal-template/src/components/logos.tsx +127 -0
  438. package/portal-template/src/components/mdx.tsx +28 -0
  439. package/portal-template/src/components/not-found.tsx +11 -0
  440. package/portal-template/src/components/plugin-install.tsx +22 -0
  441. package/portal-template/src/components/plugin-support.tsx +53 -0
  442. package/portal-template/src/components/sdk-actions.tsx +79 -0
  443. package/portal-template/src/components/sdk-cards.tsx +100 -0
  444. package/portal-template/src/components/search.tsx +41 -0
  445. package/portal-template/src/components/usage-tabs.tsx +92 -0
  446. package/portal-template/src/lib/code-samples.server.ts +40 -0
  447. package/portal-template/src/lib/code-samples.ts +43 -0
  448. package/portal-template/src/lib/code-titles.ts +29 -0
  449. package/portal-template/src/lib/install-command.ts +13 -0
  450. package/portal-template/src/lib/json.ts +5 -0
  451. package/portal-template/src/lib/layout.shared.tsx +41 -0
  452. package/portal-template/src/lib/layout.tsx +16 -0
  453. package/portal-template/src/lib/llms.server.ts +54 -0
  454. package/portal-template/src/lib/media-adapters.ts +34 -0
  455. package/portal-template/src/lib/navigation.ts +406 -0
  456. package/portal-template/src/lib/openapi-bundle.server.ts +343 -0
  457. package/portal-template/src/lib/openapi-filter.ts +191 -0
  458. package/portal-template/src/lib/openapi-labels.ts +15 -0
  459. package/portal-template/src/lib/openapi-methods.ts +12 -0
  460. package/portal-template/src/lib/openapi-section.server.ts +280 -0
  461. package/portal-template/src/lib/openapi-slim.ts +202 -0
  462. package/portal-template/src/lib/openapi.server.ts +16 -0
  463. package/portal-template/src/lib/portal-types.ts +36 -0
  464. package/portal-template/src/lib/portal.server.ts +13 -0
  465. package/portal-template/src/lib/portal.ts +11 -0
  466. package/portal-template/src/lib/rehype-code-titles.ts +53 -0
  467. package/portal-template/src/lib/request-examples.ts +72 -0
  468. package/portal-template/src/lib/seo.ts +21 -0
  469. package/portal-template/src/lib/shared.ts +51 -0
  470. package/portal-template/src/lib/shiki-bundle.ts +104 -0
  471. package/portal-template/src/lib/sitemap.server.ts +20 -0
  472. package/portal-template/src/lib/source.server.ts +27 -0
  473. package/portal-template/src/lib/source.ts +49 -0
  474. package/portal-template/src/lib/tabs.ts +37 -0
  475. package/portal-template/src/router.tsx +12 -0
  476. package/portal-template/src/routes/$.tsx +194 -0
  477. package/portal-template/src/routes/__root.tsx +56 -0
  478. package/portal-template/src/routes/api/search[.]json.ts +9 -0
  479. package/portal-template/src/routes/llms-full[.]txt.ts +10 -0
  480. package/portal-template/src/routes/llms[.]txt.ts +10 -0
  481. package/portal-template/src/routes/robots[.]txt.ts +10 -0
  482. package/portal-template/src/routes/sitemap[.]xml.ts +10 -0
  483. package/portal-template/src/routes/spa-shell.tsx +7 -0
  484. package/portal-template/src/routes/{$}[.]md.ts +21 -0
  485. package/portal-template/src/styles/app.css +33 -0
  486. package/portal-template/tsconfig.json +26 -0
  487. package/portal-template/vite.config.ts +68 -0
  488. package/lib/actions/plugin/record-sdk.d.ts +0 -14
  489. package/lib/actions/plugin/record-sdk.js +0 -60
  490. package/lib/actions/plugin/record-sdk.js.map +0 -1
  491. package/lib/actions/portal/copilot.d.ts +0 -17
  492. package/lib/actions/portal/copilot.js +0 -89
  493. package/lib/actions/portal/copilot.js.map +0 -1
  494. package/lib/actions/portal/quickstart.d.ts +0 -18
  495. package/lib/actions/portal/quickstart.js +0 -238
  496. package/lib/actions/portal/quickstart.js.map +0 -1
  497. package/lib/actions/portal/recipe/new-recipe.d.ts +0 -15
  498. package/lib/actions/portal/recipe/new-recipe.js +0 -177
  499. package/lib/actions/portal/recipe/new-recipe.js.map +0 -1
  500. package/lib/actions/portal/toc/new-toc.d.ts +0 -21
  501. package/lib/actions/portal/toc/new-toc.js +0 -95
  502. package/lib/actions/portal/toc/new-toc.js.map +0 -1
  503. package/lib/actions/sdk/merge-source-tree.d.ts +0 -12
  504. package/lib/actions/sdk/merge-source-tree.js +0 -78
  505. package/lib/actions/sdk/merge-source-tree.js.map +0 -1
  506. package/lib/actions/sdk/quickstart.d.ts +0 -18
  507. package/lib/actions/sdk/quickstart.js +0 -188
  508. package/lib/actions/sdk/quickstart.js.map +0 -1
  509. package/lib/actions/sdk/save-changes.d.ts +0 -8
  510. package/lib/actions/sdk/save-changes.js +0 -93
  511. package/lib/actions/sdk/save-changes.js.map +0 -1
  512. package/lib/application/portal/recipe/portal-recipe.d.ts +0 -8
  513. package/lib/application/portal/recipe/portal-recipe.js +0 -33
  514. package/lib/application/portal/recipe/portal-recipe.js.map +0 -1
  515. package/lib/application/portal/recipe/recipe-generator.d.ts +0 -21
  516. package/lib/application/portal/recipe/recipe-generator.js +0 -130
  517. package/lib/application/portal/recipe/recipe-generator.js.map +0 -1
  518. package/lib/application/portal/toc/toc-content-parser.d.ts +0 -5
  519. package/lib/application/portal/toc/toc-content-parser.js +0 -44
  520. package/lib/application/portal/toc/toc-content-parser.js.map +0 -1
  521. package/lib/application/portal/toc/toc-structure-generator.d.ts +0 -11
  522. package/lib/application/portal/toc/toc-structure-generator.js +0 -165
  523. package/lib/application/portal/toc/toc-structure-generator.js.map +0 -1
  524. package/lib/commands/portal/copilot.d.ts +0 -13
  525. package/lib/commands/portal/copilot.js +0 -34
  526. package/lib/commands/portal/copilot.js.map +0 -1
  527. package/lib/commands/portal/recipe/new.d.ts +0 -12
  528. package/lib/commands/portal/recipe/new.js +0 -45
  529. package/lib/commands/portal/recipe/new.js.map +0 -1
  530. package/lib/commands/portal/toc/new.d.ts +0 -16
  531. package/lib/commands/portal/toc/new.js +0 -68
  532. package/lib/commands/portal/toc/new.js.map +0 -1
  533. package/lib/commands/sdk/save-changes.d.ts +0 -14
  534. package/lib/commands/sdk/save-changes.js +0 -51
  535. package/lib/commands/sdk/save-changes.js.map +0 -1
  536. package/lib/infrastructure/debounce-service.d.ts +0 -10
  537. package/lib/infrastructure/debounce-service.js +0 -55
  538. package/lib/infrastructure/debounce-service.js.map +0 -1
  539. package/lib/infrastructure/services/portal-service.d.ts +0 -43
  540. package/lib/infrastructure/services/portal-service.js +0 -337
  541. package/lib/infrastructure/services/portal-service.js.map +0 -1
  542. package/lib/prompts/plugin/record-sdk.d.ts +0 -9
  543. package/lib/prompts/plugin/record-sdk.js +0 -40
  544. package/lib/prompts/plugin/record-sdk.js.map +0 -1
  545. package/lib/prompts/portal/copilot.d.ts +0 -18
  546. package/lib/prompts/portal/copilot.js +0 -82
  547. package/lib/prompts/portal/copilot.js.map +0 -1
  548. package/lib/prompts/portal/quickstart.d.ts +0 -42
  549. package/lib/prompts/portal/quickstart.js +0 -243
  550. package/lib/prompts/portal/quickstart.js.map +0 -1
  551. package/lib/prompts/portal/recipe/new-recipe.d.ts +0 -29
  552. package/lib/prompts/portal/recipe/new-recipe.js +0 -165
  553. package/lib/prompts/portal/recipe/new-recipe.js.map +0 -1
  554. package/lib/prompts/portal/toc/new-toc.d.ts +0 -16
  555. package/lib/prompts/portal/toc/new-toc.js +0 -50
  556. package/lib/prompts/portal/toc/new-toc.js.map +0 -1
  557. package/lib/prompts/sdk/merge-source-tree.d.ts +0 -22
  558. package/lib/prompts/sdk/merge-source-tree.js +0 -90
  559. package/lib/prompts/sdk/merge-source-tree.js.map +0 -1
  560. package/lib/prompts/sdk/quickstart.d.ts +0 -38
  561. package/lib/prompts/sdk/quickstart.js +0 -196
  562. package/lib/prompts/sdk/quickstart.js.map +0 -1
  563. package/lib/prompts/sdk/save-changes.d.ts +0 -21
  564. package/lib/prompts/sdk/save-changes.js +0 -84
  565. package/lib/prompts/sdk/save-changes.js.map +0 -1
  566. package/lib/types/build-context.d.ts +0 -26
  567. package/lib/types/build-context.js +0 -111
  568. package/lib/types/build-context.js.map +0 -1
  569. package/lib/types/events/recipe-creation-failed.d.ts +0 -5
  570. package/lib/types/events/recipe-creation-failed.js +0 -8
  571. package/lib/types/events/recipe-creation-failed.js.map +0 -1
  572. package/lib/types/events/sdk-changes-saved.d.ts +0 -8
  573. package/lib/types/events/sdk-changes-saved.js +0 -11
  574. package/lib/types/events/sdk-changes-saved.js.map +0 -1
  575. package/lib/types/events/sdk-changes-tracked.d.ts +0 -8
  576. package/lib/types/events/sdk-changes-tracked.js +0 -11
  577. package/lib/types/events/sdk-changes-tracked.js.map +0 -1
  578. package/lib/types/events/sdk-conflicts-resolved.d.ts +0 -8
  579. package/lib/types/events/sdk-conflicts-resolved.js +0 -11
  580. package/lib/types/events/sdk-conflicts-resolved.js.map +0 -1
  581. package/lib/types/events/toc-creation-failed.d.ts +0 -5
  582. package/lib/types/events/toc-creation-failed.js +0 -8
  583. package/lib/types/events/toc-creation-failed.js.map +0 -1
  584. package/lib/types/merge-source-tree-context.d.ts +0 -28
  585. package/lib/types/merge-source-tree-context.js +0 -63
  586. package/lib/types/merge-source-tree-context.js.map +0 -1
  587. package/lib/types/plugin/language-entry.d.ts +0 -9
  588. package/lib/types/plugin/language-entry.js +0 -64
  589. package/lib/types/plugin/language-entry.js.map +0 -1
  590. package/lib/types/recipe/recipe.d.ts +0 -22
  591. package/lib/types/recipe/recipe.js +0 -6
  592. package/lib/types/recipe/recipe.js.map +0 -1
  593. package/lib/types/recipe-context.d.ts +0 -9
  594. package/lib/types/recipe-context.js +0 -26
  595. package/lib/types/recipe-context.js.map +0 -1
  596. package/lib/types/save-changes-context.d.ts +0 -17
  597. package/lib/types/save-changes-context.js +0 -42
  598. package/lib/types/save-changes-context.js.map +0 -1
  599. package/lib/types/sdl/sdl.d.ts +0 -10
  600. package/lib/types/sdl/sdl.js +0 -18
  601. package/lib/types/sdl/sdl.js.map +0 -1
  602. package/lib/types/toc/toc-components.d.ts +0 -36
  603. package/lib/types/toc/toc-components.js +0 -94
  604. package/lib/types/toc/toc-components.js.map +0 -1
  605. package/lib/types/toc/toc.d.ts +0 -67
  606. package/lib/types/toc/toc.js +0 -2
  607. package/lib/types/toc/toc.js.map +0 -1
  608. package/lib/types/toc-context.d.ts +0 -12
  609. package/lib/types/toc-context.js +0 -26
  610. package/lib/types/toc-context.js.map +0 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) APIMatic
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -8,6 +8,11 @@ The official CLI for APIMatic.
8
8
  [![Downloads/week](https://img.shields.io/npm/dw/@apimatic/cli.svg)](https://npmjs.org/package/@apimatic/cli)
9
9
  [![License](https://img.shields.io/npm/l/@apimatic/cli.svg)](https://github.com/apimatic/apimatic-cli/blob/master/package.json)
10
10
 
11
+ # Requirements
12
+
13
+ Node.js 24 or newer, for every command. npm only warns when your Node is older, so the
14
+ install succeeds and the CLI then refuses to run, naming the version it found.
15
+
11
16
  # Getting Started
12
17
 
13
18
  To get started with APIMatic's CLI using a step by step wizard, run the following command:
@@ -16,6 +21,50 @@ To get started with APIMatic's CLI using a step by step wizard, run the followin
16
21
  $ apimatic quickstart
17
22
  ```
18
23
 
24
+ # Upgrading from 1.x
25
+
26
+ Documentation portals are now built on your machine from a `src/` directory, and
27
+ `APIMATIC-BUILD.json` no longer configures them:
28
+
29
+ - Describe the portal in the `portal` block of `src/apimatic.json`: `site` (its name, address
30
+ and description), `brand` (logo, favicon, primary colour and colour mode), `navigation`
31
+ (header links) and `ai` (the page actions). Running `apimatic quickstart` scaffolds the block
32
+ with every default spelled out, and the file's `$schema` lets your editor complete and check it.
33
+ - A portal also needs the project's SDK languages, at least one, in the same file's
34
+ `languages` block, for example `"languages": { "typescript": {} }`; `csharp`, `python` and
35
+ `typescript` are available for now. `plugin generate` and `sdk publish` both write to it, and
36
+ the context plugin reads it too, so name only the languages you ship. The same file carries
37
+ the plugin's identity in `plugin`; `src/plugin-config.json` is no longer read, so run
38
+ `plugin generate` and `sdk publish` again after upgrading and delete the old file.
39
+ - Put OpenAPI documents in `src/spec/`, Markdown pages in `src/content/` and images and other
40
+ files in `src/static/`.
41
+ - Every page starts with front matter giving its `title`, which names it in the sidebar.
42
+ Pages written for 1.x had none; the CLI lists each page that needs one before it builds.
43
+ ```md
44
+ ---
45
+ title: Getting started
46
+ ---
47
+ ```
48
+ - Page order comes from a `nav.json` beside your pages, listing them by file name, and a
49
+ `title` there names the folder it sits in. A folder links to its `index.md`; without one it
50
+ is only a heading.
51
+ - The top level of the portal is shown as tabs, which `src/content/nav.json` decides. Home
52
+ comes first and holds `index.md`, every other page at the top level and the folders the
53
+ file does not list, in the file's order, and opens on `index.md`; the file's `title` names
54
+ it. Each folder the file lists becomes a tab of its own after Home, in the file's order,
55
+ and so do the tabs the CLI makes, placed with `apimatic:sdks`, `apimatic:plugin` and
56
+ `apimatic:api`.
57
+ - The SDKs tab lists a card per language in the `languages` block, offering its download and,
58
+ once `sdk publish` records a release, its install command, source repository and package, and
59
+ gives each language a page carrying its SDK's getting-started docs. The Context Plugin tab,
60
+ with the plugin's install command, appears when there is a `plugin` block, or a `pluginUrl` in
61
+ the `portal` block for a plugin hosted elsewhere. Their addresses, `/sdks` and
62
+ `/context-plugin`, are kept for them, so a page in `src/content/` that would be served there
63
+ is refused.
64
+ - `portal toc new`, `portal recipe new` and `portal copilot` are gone, and `portal serve` no
65
+ longer takes `--destination` or `--no-reload`. Run `apimatic autocomplete --refresh-cache`
66
+ to drop the removed commands from shell completion.
67
+
19
68
  # Usage
20
69
  <!-- usage -->
21
70
  ```sh-session
@@ -23,7 +72,7 @@ $ npm install -g @apimatic/cli
23
72
  $ apimatic COMMAND
24
73
  running command...
25
74
  $ apimatic (--version)
26
- @apimatic/cli/1.1.0-beta.16 win32-x64 node-v23.4.0
75
+ @apimatic/cli/1.3.1 win32-x64 node-v24.19.0
27
76
  $ apimatic --help [COMMAND]
28
77
  USAGE
29
78
  $ apimatic COMMAND
@@ -42,20 +91,16 @@ USAGE
42
91
  * [`apimatic help [COMMAND]`](#apimatic-help-command)
43
92
  * [`apimatic plugin generate`](#apimatic-plugin-generate)
44
93
  * [`apimatic plugin publish`](#apimatic-plugin-publish)
45
- * [`apimatic portal copilot`](#apimatic-portal-copilot)
46
94
  * [`apimatic portal generate`](#apimatic-portal-generate)
47
- * [`apimatic portal recipe new`](#apimatic-portal-recipe-new)
48
95
  * [`apimatic portal serve`](#apimatic-portal-serve)
49
- * [`apimatic portal toc new`](#apimatic-portal-toc-new)
50
96
  * [`apimatic publishing profile list`](#apimatic-publishing-profile-list)
51
97
  * [`apimatic quickstart`](#apimatic-quickstart)
52
98
  * [`apimatic sdk generate`](#apimatic-sdk-generate)
53
99
  * [`apimatic sdk publish`](#apimatic-sdk-publish)
54
- * [`apimatic sdk save-changes`](#apimatic-sdk-save-changes)
55
100
 
56
101
  ## `apimatic api transform`
57
102
 
58
- Transform API specifications between different formats.
103
+ Transform API specifications between different formats
59
104
 
60
105
  ```
61
106
  USAGE
@@ -64,17 +109,17 @@ USAGE
64
109
  0|graphqlschema [--file <value>] [--url <value>] [-d <value>] [-f] [-k <value>]
65
110
 
66
111
  FLAGS
67
- -d, --destination=<value> [default: ./] directory to save the transformed file to
112
+ -d, --destination=<value> [default: ./] Directory to save the transformed file to
68
113
  -f, --force overwrite changes without asking for user consent.
69
114
  -k, --auth-key=<value> override current authentication state with an authentication key.
70
- --file=<value> path to the API specification file to transform
71
- --format=<option> (required) specification format to transform API specification into
115
+ --file=<value> Path to the API specification file to transform
116
+ --format=<option> (required) Specification format to transform API specification into
72
117
  <options: apimatic|wadl2009|wsdl|swagger10|swagger20|swaggeryaml|oas3|openapi3yaml|apibluep
73
118
  rint|raml|raml10|postman10|postman20|graphqlschema>
74
119
  --url=<value> URL to the API specification file to transform (publicly accessible)
75
120
 
76
121
  DESCRIPTION
77
- Transform API specifications between different formats.
122
+ Transform API specifications between different formats
78
123
 
79
124
  Transform API specifications from one format to another.
80
125
  Supports multiple formats including OpenAPI/Swagger, RAML, WSDL, and Postman Collections.
@@ -85,11 +130,11 @@ EXAMPLES
85
130
  apimatic api transform --format=raml --url="https://petstore.swagger.io/v2/swagger.json" --destination=./
86
131
  ```
87
132
 
88
- _See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/api/transform.ts)_
133
+ _See code: [src/commands/api/transform.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/api/transform.ts)_
89
134
 
90
135
  ## `apimatic api validate`
91
136
 
92
- Validate API specification for syntactic and semantic correctness.
137
+ Validate API specification for syntactic and semantic correctness
93
138
 
94
139
  ```
95
140
  USAGE
@@ -101,7 +146,7 @@ FLAGS
101
146
  --url=<value> URL to the API specification file to validate (publicly accessible)
102
147
 
103
148
  DESCRIPTION
104
- Validate API specification for syntactic and semantic correctness.
149
+ Validate API specification for syntactic and semantic correctness
105
150
 
106
151
  Validate your API specification to ensure it adheres to syntactic and semantic standards.
107
152
 
@@ -111,11 +156,11 @@ EXAMPLES
111
156
  apimatic api validate --url="https://petstore.swagger.io/v2/swagger.json"
112
157
  ```
113
158
 
114
- _See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/api/validate.ts)_
159
+ _See code: [src/commands/api/validate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/api/validate.ts)_
115
160
 
116
161
  ## `apimatic auth login`
117
162
 
118
- Login to your APIMatic account.
163
+ Login to your APIMatic account
119
164
 
120
165
  ```
121
166
  USAGE
@@ -125,7 +170,7 @@ FLAGS
125
170
  -k, --auth-key=<value> Sets authentication key for all commands.
126
171
 
127
172
  DESCRIPTION
128
- Login to your APIMatic account.
173
+ Login to your APIMatic account
129
174
 
130
175
  Login using your APIMatic credentials or an API Key
131
176
 
@@ -135,7 +180,7 @@ EXAMPLES
135
180
  apimatic auth login --auth-key={api-key}
136
181
  ```
137
182
 
138
- _See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/auth/login.ts)_
183
+ _See code: [src/commands/auth/login.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/auth/login.ts)_
139
184
 
140
185
  ## `apimatic auth logout`
141
186
 
@@ -154,7 +199,7 @@ EXAMPLES
154
199
  apimatic auth logout
155
200
  ```
156
201
 
157
- _See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/auth/logout.ts)_
202
+ _See code: [src/commands/auth/logout.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/auth/logout.ts)_
158
203
 
159
204
  ## `apimatic auth status`
160
205
 
@@ -171,7 +216,7 @@ EXAMPLES
171
216
  apimatic auth status
172
217
  ```
173
218
 
174
- _See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/auth/status.ts)_
219
+ _See code: [src/commands/auth/status.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/auth/status.ts)_
175
220
 
176
221
  ## `apimatic autocomplete [SHELL]`
177
222
 
@@ -182,7 +227,7 @@ USAGE
182
227
  $ apimatic autocomplete [SHELL] [-r]
183
228
 
184
229
  ARGUMENTS
185
- SHELL (zsh|bash|powershell) Shell type
230
+ [SHELL] (zsh|bash|powershell) Shell type
186
231
 
187
232
  FLAGS
188
233
  -r, --refresh-cache Refresh cache (ignores displaying instructions)
@@ -202,7 +247,7 @@ EXAMPLES
202
247
  $ apimatic autocomplete --refresh-cache
203
248
  ```
204
249
 
205
- _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/main/src/commands/autocomplete/index.ts)_
250
+ _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.47/src/commands/autocomplete/index.ts)_
206
251
 
207
252
  ## `apimatic help [COMMAND]`
208
253
 
@@ -213,7 +258,7 @@ USAGE
213
258
  $ apimatic help [COMMAND...] [-n]
214
259
 
215
260
  ARGUMENTS
216
- COMMAND... Command to show help for.
261
+ [COMMAND...] Command to show help for.
217
262
 
218
263
  FLAGS
219
264
  -n, --nested-commands Include all nested commands in the output.
@@ -222,11 +267,11 @@ DESCRIPTION
222
267
  Display help for apimatic.
223
268
  ```
224
269
 
225
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/main/src/commands/help.ts)_
270
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.46/src/commands/help.ts)_
226
271
 
227
272
  ## `apimatic plugin generate`
228
273
 
229
- Generate a context plugin for your published SDKs.
274
+ Generate a context plugin for your SDKs.
230
275
 
231
276
  ```
232
277
  USAGE
@@ -240,10 +285,12 @@ FLAGS
240
285
  -k, --auth-key=<value> override current authentication state with an authentication key.
241
286
 
242
287
  DESCRIPTION
243
- Generate a context plugin for your published SDKs.
288
+ Generate a context plugin for your SDKs.
244
289
 
245
290
  Generate a context plugin that teaches an AI coding assistant how to use your SDKs. Requires an input directory
246
- containing a `src` directory with a `plugin-config.json`.
291
+ containing a `src` directory with your API specification — `apimatic.json` is created if it is not there. It asks
292
+ for the plugin's name on the first run, and for its languages only when `apimatic.json` records none (`sdk publish`
293
+ records them). Later runs read both from `apimatic.json` without asking.
247
294
 
248
295
  EXAMPLES
249
296
  apimatic plugin generate
@@ -251,7 +298,7 @@ EXAMPLES
251
298
  apimatic plugin generate --input="./" --destination="./plugin"
252
299
  ```
253
300
 
254
- _See code: [src/commands/plugin/generate.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/plugin/generate.ts)_
301
+ _See code: [src/commands/plugin/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/plugin/generate.ts)_
255
302
 
256
303
  ## `apimatic plugin publish`
257
304
 
@@ -278,45 +325,15 @@ EXAMPLES
278
325
  apimatic plugin publish --input="./" --destination="./plugin"
279
326
  ```
280
327
 
281
- _See code: [src/commands/plugin/publish.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/plugin/publish.ts)_
282
-
283
- ## `apimatic portal copilot`
284
-
285
- Configure API Copilot for your API Documentation portal
286
-
287
- ```
288
- USAGE
289
- $ apimatic portal copilot [-i <value>] [--disable] [-f] [-k <value>]
290
-
291
- FLAGS
292
- -f, --force overwrite changes without asking for user consent.
293
- -i, --input=<value> [default: ./] path to the parent directory containing the 'src' directory, which includes API
294
- specifications and configuration files.
295
- -k, --auth-key=<value> override current authentication state with an authentication key.
296
- --disable marks the API Copilot as disabled in the configuration
297
-
298
- DESCRIPTION
299
- Configure API Copilot for your API Documentation portal
300
-
301
- Displays available API Copilots associated with your account and allows you to select which one to integrate with your
302
- portal. Each APIMatic account includes one Copilot by default. The selected Copilot will be added to your
303
- 'APIMATIC-BUILD.json' file
304
-
305
- EXAMPLES
306
- apimatic portal copilot --input=./
307
-
308
- apimatic portal copilot --input=./ --disable
309
- ```
310
-
311
- _See code: [src/commands/portal/copilot.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/portal/copilot.ts)_
328
+ _See code: [src/commands/plugin/publish.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/plugin/publish.ts)_
312
329
 
313
330
  ## `apimatic portal generate`
314
331
 
315
- Generate an API Documentation portal.
332
+ Generate a static API Documentation Portal.
316
333
 
317
334
  ```
318
335
  USAGE
319
- $ apimatic portal generate [-i <value>] [-d <value>] [-f] [--zip] [-k <value>]
336
+ $ apimatic portal generate [--zip] [-i <value>] [-d <value>] [-f] [-k <value>]
320
337
 
321
338
  FLAGS
322
339
  -d, --destination=<value> [default: <input>/portal] path where the portal will be generated.
@@ -324,127 +341,61 @@ FLAGS
324
341
  -i, --input=<value> [default: ./] path to the parent directory containing the 'src' directory, which includes
325
342
  API specifications and configuration files.
326
343
  -k, --auth-key=<value> override current authentication state with an authentication key.
327
- --zip download the generated portal as a .zip archive
344
+ --zip write the generated portal as a .zip archive.
328
345
 
329
346
  DESCRIPTION
330
- Generate an API Documentation portal.
347
+ Generate a static API Documentation Portal.
331
348
 
332
- Generate an API Documentation portal. Requires an input directory containing API specifications, a config file and
333
- optionally, markdown guides. For details, refer to the [documentation](https://docs.apimatic.io/platform-api/#/http/gu
334
- ides/generating-on-prem-api-portal/build-file-reference)
349
+ Builds a documentation portal from the OpenAPI documents and Markdown pages in your 'src' directory.
350
+
351
+ The portal is built on your machine and written as static files you can host anywhere. Configure it with
352
+ 'src/apimatic.json', whose 'languages' block gives the portal a page for each SDK language, and whose 'plugin' block,
353
+ or a 'pluginUrl' in its 'portal' block for a plugin hosted elsewhere, a page for the context plugin.
335
354
 
336
355
  EXAMPLES
337
356
  apimatic portal generate
338
357
 
339
- apimatic portal generate --input="./" --destination="./portal"
340
- ```
341
-
342
- _See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/portal/generate.ts)_
343
-
344
- ## `apimatic portal recipe new`
345
-
346
- Add an API Recipe to your API documentation portal.
358
+ apimatic portal generate --input=./ --destination=./portal
347
359
 
360
+ apimatic portal generate --zip
348
361
  ```
349
- USAGE
350
- $ apimatic portal recipe new [--name <value>] [-i <value>] [-f]
351
-
352
- FLAGS
353
- -f, --force overwrite changes without asking for user consent.
354
- -i, --input=<value> [default: ./] path to the parent directory containing the 'src' directory, which includes API
355
- specifications and configuration files.
356
- --name=<value> name for the recipe
357
-
358
- DESCRIPTION
359
- Add an API Recipe to your API documentation portal.
360
-
361
- This command adds a new API Recipe file to your documentation portal.
362
362
 
363
- To learn more about API Recipes, visit:
364
- https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/api-recipes
365
-
366
- EXAMPLES
367
- apimatic portal recipe new
368
-
369
- apimatic portal recipe new --name="My API Recipe" --input="./"
370
- ```
371
-
372
- _See code: [src/commands/portal/recipe/new.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/portal/recipe/new.ts)_
363
+ _See code: [src/commands/portal/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/portal/generate.ts)_
373
364
 
374
365
  ## `apimatic portal serve`
375
366
 
376
- Generate and serve an API Documentation Portal with hot reload.
377
-
378
- ```
379
- USAGE
380
- $ apimatic portal serve [-p 3000] [-i <value>] [-d <value>] [-o] [--no-reload] [-k <value>]
381
-
382
- FLAGS
383
- -d, --destination=<value> [default: <input>/portal] path where the portal will be generated.
384
- -i, --input=<value> [default: ./] path to the parent directory containing the 'src' directory, which includes
385
- API specifications and configuration files.
386
- -k, --auth-key=<value> override current authentication state with an authentication key.
387
- -o, --open open the portal in the default browser.
388
- -p, --port=3000 [default: 3000] port to serve the portal.
389
- --no-reload disable hot reload.
390
-
391
- DESCRIPTION
392
- Generate and serve an API Documentation Portal with hot reload.
393
-
394
- Requires an input directory with API specifications, a config file, and optionally markdown guides. Supports disabling
395
- hot reload and opening the portal in the default browser.
396
-
397
- EXAMPLES
398
- apimatic portal serve
399
-
400
- apimatic portal serve --input=./ --destination=./portal --port=3000 --open --no-reload
401
- ```
402
-
403
- _See code: [src/commands/portal/serve.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/portal/serve.ts)_
404
-
405
- ## `apimatic portal toc new`
406
-
407
- Generate a Table of Contents (TOC) file for your API documentation portal
367
+ Preview your API Documentation Portal with live reload.
408
368
 
409
369
  ```
410
370
  USAGE
411
- $ apimatic portal toc new [-d <value>] [-i <value>] [-f] [--expand-endpoints] [--expand-models]
412
- [--expand-webhooks] [--expand-callbacks]
371
+ $ apimatic portal serve [-p 23513] [-o] [-i <value>] [-k <value>]
413
372
 
414
373
  FLAGS
415
- -d, --destination=<value> [default: <input>/src/content] path where the toc.yml will be generated.
416
- -f, --force overwrite changes without asking for user consent.
417
- -i, --input=<value> [default: ./] path to the parent directory containing the 'src' directory, which includes
418
- API specifications and configuration files.
419
- --expand-callbacks include individual entries for each callback in the generated 'toc.yml'. Requires a valid
420
- API specification in the working directory.
421
- --expand-endpoints include individual entries for each endpoint in the generated 'toc.yml'. Requires a valid
422
- API specification in the working directory.
423
- --expand-models include individual entries for each model in the generated 'toc.yml'. Requires a valid API
424
- specification in the working directory.
425
- --expand-webhooks include individual entries for each webhook in the generated 'toc.yml'. Requires a valid
426
- API specification in the working directory.
374
+ -i, --input=<value> [default: ./] path to the parent directory containing the 'src' directory, which includes API
375
+ specifications and configuration files.
376
+ -k, --auth-key=<value> override current authentication state with an authentication key.
377
+ -o, --open open the portal in the default browser.
378
+ -p, --port=23513 [default: 23513] port to serve the portal on.
427
379
 
428
380
  DESCRIPTION
429
- Generate a Table of Contents (TOC) file for your API documentation portal
381
+ Preview your API Documentation Portal with live reload.
430
382
 
431
- This command generates a new Table of Contents (TOC) file used in the
432
- generation of your API documentation portal.
383
+ Serves the portal described by 'src/apimatic.json' from your machine, reloading the browser as you edit the Markdown
384
+ pages in 'src/content', reorder them in a 'nav.json', or change the 'portal', 'languages' or 'plugin' block of
385
+ 'apimatic.json'.
433
386
 
434
- The output is a YAML file with the .yml extension.
387
+ Adding a language or a 'plugin' block, adding or removing a page in 'src/content', creating 'src/static', or changing
388
+ which documents are in 'src/spec', needs the preview restarted.
435
389
 
436
- To learn more about the TOC file and APIMatic build directory structure, visit:
437
- https://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/overview-generating-api-portal
390
+ Nothing is written to disk; run 'apimatic portal generate' to produce the static files.
438
391
 
439
392
  EXAMPLES
440
- apimatic portal toc new --destination=./src/content/
441
-
442
- apimatic portal toc new --input=./
393
+ apimatic portal serve
443
394
 
444
- apimatic portal toc new --input=./ --destination=./src/content/
395
+ apimatic portal serve --input=./ --port=23513 --open
445
396
  ```
446
397
 
447
- _See code: [src/commands/portal/toc/new.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/portal/toc/new.ts)_
398
+ _See code: [src/commands/portal/serve.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/portal/serve.ts)_
448
399
 
449
400
  ## `apimatic publishing profile list`
450
401
 
@@ -463,26 +414,27 @@ EXAMPLES
463
414
  apimatic publishing profile list
464
415
  ```
465
416
 
466
- _See code: [src/commands/publishing/profile/list.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/publishing/profile/list.ts)_
417
+ _See code: [src/commands/publishing/profile/list.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/publishing/profile/list.ts)_
467
418
 
468
419
  ## `apimatic quickstart`
469
420
 
470
- Create your first SDK or API Portal using APIMatic.
421
+ Create your first API Documentation Portal, SDKs and Context Plugins.
471
422
 
472
423
  ```
473
424
  USAGE
474
425
  $ apimatic quickstart
475
426
 
476
427
  DESCRIPTION
477
- Create your first SDK or API Portal using APIMatic.
428
+ Create your first API Documentation Portal, SDKs and Context Plugins.
478
429
 
479
- Get started with your first SDK or API Portal in four easy steps.
430
+ Point the CLI at your API specification and it builds a documentation portal, SDKs, and a context plugin that teaches
431
+ an AI coding assistant to use them.
480
432
 
481
433
  EXAMPLES
482
434
  apimatic quickstart
483
435
  ```
484
436
 
485
- _See code: [src/commands/quickstart.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/quickstart.ts)_
437
+ _See code: [src/commands/quickstart.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/quickstart.ts)_
486
438
 
487
439
  ## `apimatic sdk generate`
488
440
 
@@ -490,9 +442,8 @@ Generate an SDK for your API
490
442
 
491
443
  ```
492
444
  USAGE
493
- $ apimatic sdk generate -l csharp|java|php|python|ruby|typescript|go [-d <value>] [--skip-changes]
494
- [--api-version <value>] [--zip] [--track-changes] [--codegen-version v3|v4] [--stability stable|beta] [-i <value>]
495
- [-f] [-k <value>]
445
+ $ apimatic sdk generate -l csharp|java|php|python|ruby|typescript|go [-d <value>] [--api-version <value>]
446
+ [--zip] [--codegen-version v4] [--stability stable|beta] [-i <value>] [-f] [-k <value>]
496
447
 
497
448
  FLAGS
498
449
  -d, --destination=<value> [default: <input>/sdk/<language> | <input>/sdk/<api-version>/<language>] path where
@@ -504,29 +455,27 @@ FLAGS
504
455
  -l, --language=<option> (required) Programming language for SDK generation
505
456
  <options: csharp|java|php|python|ruby|typescript|go>
506
457
  --api-version=<value> Version of the API to use for SDK generation (if multiple versions exist)
507
- --codegen-version=<option> [default: v3] Version of the code generator to use
508
- <options: v3|v4>
509
- --skip-changes Do not apply the saved changes to the generated SDK
510
- --stability=<option> [default: stable] Stability level of the generated SDK
458
+ --codegen-version=<option> [default: v4] Version of the code generator to use
459
+ <options: v4>
460
+ --stability=<option> Stability level of the generated SDK. Defaults to the level the language offers.
511
461
  <options: stable|beta>
512
- --track-changes Enable change tracking for SDK generation (only required for initial setup)
513
462
  --zip Download the generated SDK as a .zip archive
514
463
 
515
464
  DESCRIPTION
516
465
  Generate an SDK for your API
517
466
 
518
- Generate Software Development Kits (SDKs) from API specifications.
519
- Supports multiple programming languages including Java, C#, Python, JavaScript, and more.
467
+ Generate a Software Development Kit (SDK) from an API specification.
468
+ C#, TypeScript and Python are available; Java, Ruby, Go and PHP are on their way.
520
469
 
521
470
  EXAMPLES
522
- apimatic sdk generate --language=java
471
+ apimatic sdk generate --language=typescript
523
472
 
524
473
  apimatic sdk generate --language=csharp --input=./
525
474
 
526
475
  apimatic sdk generate --language=python --destination=./sdk --zip
527
476
  ```
528
477
 
529
- _See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/sdk/generate.ts)_
478
+ _See code: [src/commands/sdk/generate.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/sdk/generate.ts)_
530
479
 
531
480
  ## `apimatic sdk publish`
532
481
 
@@ -534,8 +483,9 @@ Generate and publish an SDK to a package registry and/or source repository
534
483
 
535
484
  ```
536
485
  USAGE
537
- $ apimatic sdk publish [-p <value>] [-v <value>] [-d <value>] [-l csharp|java|php|python|ruby|typescript] [-f]
538
- [-i <value>] [--publish-type package|sourcecode...] [--dry-run] [--codegen-version v3|v4] [--stability stable|beta]
486
+ $ apimatic sdk publish [-p <value>] [-v <value>] [-d <value>] [-l csharp|java|php|python|ruby|typescript|go]
487
+ [-f] [-i <value>] [--publish-type package|sourcecode...] [--dry-run] [--codegen-version v4] [--stability
488
+ stable|beta]
539
489
 
540
490
  FLAGS
541
491
  -d, --destination=<value> [default: <input>/sdk] path where the sdk will be generated.
@@ -543,16 +493,16 @@ FLAGS
543
493
  -i, --input=<value> [default: ./] path to the parent directory containing the 'src' directory, which
544
494
  includes API specifications and configuration files.
545
495
  -l, --language=<option> Language of the SDK to generate and publish.
546
- <options: csharp|java|php|python|ruby|typescript>
496
+ <options: csharp|java|php|python|ruby|typescript|go>
547
497
  -p, --profile-id=<value> Id of the publishing profile to use.
548
498
  -v, --version=<value> Semantic version of the SDK to publish (e.g. 1.0.0).
549
- --codegen-version=<option> [default: v3] Version of the code generator to use
550
- <options: v3|v4>
499
+ --codegen-version=<option> [default: v4] Version of the code generator to use
500
+ <options: v4>
551
501
  --dry-run Generate the SDK locally for review without publishing.
552
502
  --publish-type=<option>... One or more publishing targets: 'package' for a package registry, 'sourcecode' for a
553
503
  git repository.
554
504
  <options: package|sourcecode>
555
- --stability=<option> [default: stable] Stability level of the generated SDK
505
+ --stability=<option> Stability level of the generated SDK. Defaults to the level the language offers.
556
506
  <options: stable|beta>
557
507
 
558
508
  DESCRIPTION
@@ -567,44 +517,10 @@ EXAMPLES
567
517
 
568
518
  apimatic sdk publish --profile-id=a1b2c3d4e5f6a1b2c3d4e5f6 --language=typescript --version=1.0.0 --publish-type=package --publish-type=sourcecode
569
519
 
570
- apimatic sdk publish --profile-id=b2c3d4e5f6a1b2c3d4e5f6a1 --language=java --version=2.0.0 --publish-type=sourcecode
520
+ apimatic sdk publish --profile-id=b2c3d4e5f6a1b2c3d4e5f6a1 --language=csharp --version=2.0.0 --publish-type=sourcecode
571
521
 
572
522
  apimatic sdk publish --profile-id=c3d4e5f6a1b2c3d4e5f6a1b2 --language=python --version=1.0.0 --publish-type=package --dry-run
573
-
574
- apimatic sdk publish --profile-id=d4e5f6a1b2c3d4e5f6a1b2c3 --language=csharp --version=1.0.0 --publish-type=package --codegen-version=v4 --stability=beta
575
- ```
576
-
577
- _See code: [src/commands/sdk/publish.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/sdk/publish.ts)_
578
-
579
- ## `apimatic sdk save-changes`
580
-
581
- Save customizations made to an auto-generated SDK
582
-
583
- ```
584
- USAGE
585
- $ apimatic sdk save-changes -l csharp|java|php|python|ruby|typescript|go [--sdk <value>] [--api-version <value>] [-i
586
- <value>]
587
-
588
- FLAGS
589
- -i, --input=<value> [default: ./] path to the parent directory containing the 'src' directory, which includes
590
- API specifications and configuration files.
591
- -l, --language=<option> (required) Programming language of the SDK
592
- <options: csharp|java|php|python|ruby|typescript|go>
593
- --api-version=<value> Version of the API where changes should be saved (if multiple versions exist).
594
- --sdk=<value> [default: ./sdk/<language> | ./sdk/<api-version>/<language>] path to the folder containing
595
- the updated SDK.
596
-
597
- DESCRIPTION
598
- Save customizations made to an auto-generated SDK
599
-
600
- Requires an input directory with API specifications, a path to the updated SDK directory, and the programming
601
- language.
602
-
603
- EXAMPLES
604
- apimatic sdk save-changes --language=csharp
605
-
606
- apimatic sdk save-changes --language=java --sdk=./sdk
607
523
  ```
608
524
 
609
- _See code: [src/commands/sdk/save-changes.ts](https://github.com/apimatic/apimatic-cli/blob/beta/src/commands/sdk/save-changes.ts)_
525
+ _See code: [src/commands/sdk/publish.ts](https://github.com/apimatic/apimatic-cli/blob/v1.3.1/src/commands/sdk/publish.ts)_
610
526
  <!-- commandsstop -->