@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.
- package/LICENSE +21 -0
- package/README.md +128 -212
- package/apimatic.schema.json +550 -0
- package/lib/actions/action-result.js +3 -0
- package/lib/actions/action-result.js.map +1 -1
- package/lib/actions/api/transform.js +36 -33
- package/lib/actions/api/transform.js.map +1 -1
- package/lib/actions/api/validate.d.ts +9 -6
- package/lib/actions/api/validate.js +44 -38
- package/lib/actions/api/validate.js.map +1 -1
- package/lib/actions/auth/login.js +7 -4
- package/lib/actions/auth/login.js.map +1 -1
- package/lib/actions/auth/logout.js +2 -1
- package/lib/actions/auth/logout.js.map +1 -1
- package/lib/actions/auth/status.js +5 -3
- package/lib/actions/auth/status.js.map +1 -1
- package/lib/actions/plugin/generate.d.ts +5 -1
- package/lib/actions/plugin/generate.js +83 -56
- package/lib/actions/plugin/generate.js.map +1 -1
- package/lib/actions/plugin/publish.d.ts +2 -1
- package/lib/actions/plugin/publish.js +34 -37
- package/lib/actions/plugin/publish.js.map +1 -1
- package/lib/actions/plugin/record-metadata.d.ts +3 -2
- package/lib/actions/plugin/record-metadata.js +33 -30
- package/lib/actions/plugin/record-metadata.js.map +1 -1
- package/lib/actions/portal/generate.d.ts +8 -6
- package/lib/actions/portal/generate.js +50 -61
- package/lib/actions/portal/generate.js.map +1 -1
- package/lib/actions/portal/prepare-project.d.ts +25 -0
- package/lib/actions/portal/prepare-project.js +68 -0
- package/lib/actions/portal/prepare-project.js.map +1 -0
- package/lib/actions/portal/serve.d.ts +21 -6
- package/lib/actions/portal/serve.js +170 -153
- package/lib/actions/portal/serve.js.map +1 -1
- package/lib/actions/publishing/profile/list.js +4 -2
- package/lib/actions/publishing/profile/list.js.map +1 -1
- package/lib/actions/quickstart.d.ts +23 -5
- package/lib/actions/quickstart.js +222 -21
- package/lib/actions/quickstart.js.map +1 -1
- package/lib/actions/sdk/generate.d.ts +4 -7
- package/lib/actions/sdk/generate.js +53 -93
- package/lib/actions/sdk/generate.js.map +1 -1
- package/lib/actions/sdk/publish/interactive.d.ts +4 -3
- package/lib/actions/sdk/publish/interactive.js +96 -97
- package/lib/actions/sdk/publish/interactive.js.map +1 -1
- package/lib/actions/sdk/publish/non-interactive.d.ts +4 -2
- package/lib/actions/sdk/publish/non-interactive.js +91 -90
- package/lib/actions/sdk/publish/non-interactive.js.map +1 -1
- package/lib/actions/sdk/publish.d.ts +3 -2
- package/lib/actions/sdk/publish.js +55 -53
- package/lib/actions/sdk/publish.js.map +1 -1
- package/lib/actions/sdk/record-published-sdk.d.ts +14 -0
- package/lib/actions/sdk/record-published-sdk.js +57 -0
- package/lib/actions/sdk/record-published-sdk.js.map +1 -0
- package/lib/client-utils/auth-manager.js +1 -1
- package/lib/client-utils/auth-manager.js.map +1 -1
- package/lib/commands/api/transform.d.ts +1 -1
- package/lib/commands/api/transform.js +44 -40
- package/lib/commands/api/transform.js.map +1 -1
- package/lib/commands/api/validate.js +16 -16
- package/lib/commands/api/validate.js.map +1 -1
- package/lib/commands/auth/login.js +14 -15
- package/lib/commands/auth/login.js.map +1 -1
- package/lib/commands/auth/logout.js +5 -6
- package/lib/commands/auth/logout.js.map +1 -1
- package/lib/commands/auth/status.js +4 -5
- package/lib/commands/auth/status.js.map +1 -1
- package/lib/commands/plugin/generate.d.ts +3 -3
- package/lib/commands/plugin/generate.js +20 -20
- package/lib/commands/plugin/generate.js.map +1 -1
- package/lib/commands/plugin/publish.js +18 -18
- package/lib/commands/plugin/publish.js.map +1 -1
- package/lib/commands/portal/generate.d.ts +9 -8
- package/lib/commands/portal/generate.js +36 -27
- package/lib/commands/portal/generate.js.map +1 -1
- package/lib/commands/portal/serve.d.ts +7 -9
- package/lib/commands/portal/serve.js +41 -44
- package/lib/commands/portal/serve.js.map +1 -1
- package/lib/commands/publishing/profile/list.js +8 -12
- package/lib/commands/publishing/profile/list.js.map +1 -1
- package/lib/commands/quickstart.d.ts +5 -5
- package/lib/commands/quickstart.js +18 -24
- package/lib/commands/quickstart.js.map +1 -1
- package/lib/commands/sdk/generate.d.ts +5 -7
- package/lib/commands/sdk/generate.js +58 -70
- package/lib/commands/sdk/generate.js.map +1 -1
- package/lib/commands/sdk/publish.d.ts +6 -7
- package/lib/commands/sdk/publish.js +66 -60
- package/lib/commands/sdk/publish.js.map +1 -1
- package/lib/hooks/node-version.d.ts +3 -0
- package/lib/hooks/node-version.js +12 -0
- package/lib/hooks/node-version.js.map +1 -0
- package/lib/hooks/not-found.js +2 -3
- package/lib/hooks/not-found.js.map +1 -1
- package/lib/hooks/utils.d.ts +4 -2
- package/lib/hooks/utils.js +2 -2
- package/lib/hooks/utils.js.map +1 -1
- package/lib/infrastructure/env-info.d.ts +3 -0
- package/lib/infrastructure/env-info.js +13 -6
- package/lib/infrastructure/env-info.js.map +1 -1
- package/lib/infrastructure/file-service.d.ts +35 -8
- package/lib/infrastructure/file-service.js +149 -53
- package/lib/infrastructure/file-service.js.map +1 -1
- package/lib/infrastructure/file-watch-service.d.ts +40 -0
- package/lib/infrastructure/file-watch-service.js +167 -0
- package/lib/infrastructure/file-watch-service.js.map +1 -0
- package/lib/infrastructure/generation-status-poller.d.ts +8 -7
- package/lib/infrastructure/generation-status-poller.js +20 -12
- package/lib/infrastructure/generation-status-poller.js.map +1 -1
- package/lib/infrastructure/launcher-service.js +6 -6
- package/lib/infrastructure/launcher-service.js.map +1 -1
- package/lib/infrastructure/network-service.d.ts +3 -0
- package/lib/infrastructure/network-service.js +15 -1
- package/lib/infrastructure/network-service.js.map +1 -1
- package/lib/infrastructure/portal-build-service.d.ts +19 -0
- package/lib/infrastructure/portal-build-service.js +58 -0
- package/lib/infrastructure/portal-build-service.js.map +1 -0
- package/lib/infrastructure/portal-dev-server-service.d.ts +29 -0
- package/lib/infrastructure/portal-dev-server-service.js +135 -0
- package/lib/infrastructure/portal-dev-server-service.js.map +1 -0
- package/lib/infrastructure/portal-pages-service.d.ts +17 -0
- package/lib/infrastructure/portal-pages-service.js +103 -0
- package/lib/infrastructure/portal-pages-service.js.map +1 -0
- package/lib/infrastructure/portal-project-service.d.ts +77 -0
- package/lib/infrastructure/portal-project-service.js +309 -0
- package/lib/infrastructure/portal-project-service.js.map +1 -0
- package/lib/infrastructure/service-error.d.ts +1 -0
- package/lib/infrastructure/service-error.js +39 -41
- package/lib/infrastructure/service-error.js.map +1 -1
- package/lib/infrastructure/services/api-client-factory.js +15 -13
- package/lib/infrastructure/services/api-client-factory.js.map +1 -1
- package/lib/infrastructure/services/api-service.d.ts +7 -5
- package/lib/infrastructure/services/api-service.js +28 -20
- package/lib/infrastructure/services/api-service.js.map +1 -1
- package/lib/infrastructure/services/auth-service.js +4 -9
- package/lib/infrastructure/services/auth-service.js.map +1 -1
- package/lib/infrastructure/services/file-download-service.js +3 -3
- package/lib/infrastructure/services/file-download-service.js.map +1 -1
- package/lib/infrastructure/services/plugin-service.d.ts +1 -8
- package/lib/infrastructure/services/plugin-service.js +11 -22
- package/lib/infrastructure/services/plugin-service.js.map +1 -1
- package/lib/infrastructure/services/portal-artifacts-service.d.ts +44 -0
- package/lib/infrastructure/services/portal-artifacts-service.js +268 -0
- package/lib/infrastructure/services/portal-artifacts-service.js.map +1 -0
- package/lib/infrastructure/services/portal-authorization-service.d.ts +22 -0
- package/lib/infrastructure/services/portal-authorization-service.js +23 -0
- package/lib/infrastructure/services/portal-authorization-service.js.map +1 -0
- package/lib/infrastructure/services/publishing-api-service.d.ts +1 -1
- package/lib/infrastructure/services/publishing-api-service.js +11 -15
- package/lib/infrastructure/services/publishing-api-service.js.map +1 -1
- package/lib/infrastructure/services/sdk-generation-service.d.ts +21 -0
- package/lib/infrastructure/services/sdk-generation-service.js +118 -0
- package/lib/infrastructure/services/sdk-generation-service.js.map +1 -0
- package/lib/infrastructure/services/telemetry-service.js +5 -4
- package/lib/infrastructure/services/telemetry-service.js.map +1 -1
- package/lib/infrastructure/services/transformation-service.js +29 -32
- package/lib/infrastructure/services/transformation-service.js.map +1 -1
- package/lib/infrastructure/services/validation-service.d.ts +12 -53
- package/lib/infrastructure/services/validation-service.js +24 -199
- package/lib/infrastructure/services/validation-service.js.map +1 -1
- package/lib/infrastructure/timer-extensions.d.ts +2 -0
- package/lib/infrastructure/timer-extensions.js +10 -0
- package/lib/infrastructure/timer-extensions.js.map +1 -0
- package/lib/infrastructure/tmp-extensions.d.ts +31 -1
- package/lib/infrastructure/tmp-extensions.js +86 -3
- package/lib/infrastructure/tmp-extensions.js.map +1 -1
- package/lib/infrastructure/zip-service.js +2 -2
- package/lib/infrastructure/zip-service.js.map +1 -1
- package/lib/prompts/api/validate.d.ts +6 -7
- package/lib/prompts/api/validate.js +12 -12
- package/lib/prompts/api/validate.js.map +1 -1
- package/lib/prompts/format.d.ts +4 -0
- package/lib/prompts/format.js +5 -0
- package/lib/prompts/format.js.map +1 -1
- package/lib/prompts/plugin/generate.d.ts +17 -12
- package/lib/prompts/plugin/generate.js +94 -44
- package/lib/prompts/plugin/generate.js.map +1 -1
- package/lib/prompts/plugin/publish.d.ts +2 -1
- package/lib/prompts/plugin/publish.js +8 -7
- package/lib/prompts/plugin/publish.js.map +1 -1
- package/lib/prompts/plugin/record-metadata.d.ts +1 -0
- package/lib/prompts/plugin/record-metadata.js +10 -7
- package/lib/prompts/plugin/record-metadata.js.map +1 -1
- package/lib/prompts/portal/artifacts.d.ts +8 -0
- package/lib/prompts/portal/artifacts.js +26 -0
- package/lib/prompts/portal/artifacts.js.map +1 -0
- package/lib/prompts/portal/authorization.d.ts +6 -0
- package/lib/prompts/portal/authorization.js +29 -0
- package/lib/prompts/portal/authorization.js.map +1 -0
- package/lib/prompts/portal/code-samples.d.ts +1 -0
- package/lib/prompts/portal/code-samples.js +9 -0
- package/lib/prompts/portal/code-samples.js.map +1 -0
- package/lib/prompts/portal/generate.d.ts +14 -9
- package/lib/prompts/portal/generate.js +48 -26
- package/lib/prompts/portal/generate.js.map +1 -1
- package/lib/prompts/portal/prepare-project.d.ts +20 -0
- package/lib/prompts/portal/prepare-project.js +36 -0
- package/lib/prompts/portal/prepare-project.js.map +1 -0
- package/lib/prompts/portal/serve.d.ts +32 -12
- package/lib/prompts/portal/serve.js +102 -39
- package/lib/prompts/portal/serve.js.map +1 -1
- package/lib/prompts/portal/source.d.ts +26 -0
- package/lib/prompts/portal/source.js +253 -0
- package/lib/prompts/portal/source.js.map +1 -0
- package/lib/prompts/prompt.d.ts +11 -3
- package/lib/prompts/prompt.js +39 -15
- package/lib/prompts/prompt.js.map +1 -1
- package/lib/prompts/quickstart.d.ts +46 -3
- package/lib/prompts/quickstart.js +199 -12
- package/lib/prompts/quickstart.js.map +1 -1
- package/lib/prompts/sdk/generate.d.ts +15 -13
- package/lib/prompts/sdk/generate.js +29 -32
- package/lib/prompts/sdk/generate.js.map +1 -1
- package/lib/prompts/sdk/publish/interactive.d.ts +10 -6
- package/lib/prompts/sdk/publish/interactive.js +26 -24
- package/lib/prompts/sdk/publish/interactive.js.map +1 -1
- package/lib/prompts/sdk/publish/non-interactive.d.ts +2 -1
- package/lib/prompts/sdk/publish/non-interactive.js +5 -4
- package/lib/prompts/sdk/publish/non-interactive.js.map +1 -1
- package/lib/prompts/sdk/publish.d.ts +3 -3
- package/lib/prompts/sdk/publish.js +13 -17
- package/lib/prompts/sdk/publish.js.map +1 -1
- package/lib/prompts/sdk/record-published-sdk.d.ts +7 -0
- package/lib/prompts/sdk/record-published-sdk.js +26 -0
- package/lib/prompts/sdk/record-published-sdk.js.map +1 -0
- package/lib/types/apimatic-config/document.d.ts +70 -0
- package/lib/types/apimatic-config/document.js +167 -0
- package/lib/types/apimatic-config/document.js.map +1 -0
- package/lib/types/apimatic-config/languages-block.d.ts +39 -0
- package/lib/types/apimatic-config/languages-block.js +58 -0
- package/lib/types/apimatic-config/languages-block.js.map +1 -0
- package/lib/types/apimatic-config-context.d.ts +48 -0
- package/lib/types/apimatic-config-context.js +121 -0
- package/lib/types/apimatic-config-context.js.map +1 -0
- package/lib/types/build/build.d.ts +1 -89
- package/lib/types/build/build.js +6 -161
- package/lib/types/build/build.js.map +1 -1
- package/lib/types/events/domain-event.js +3 -0
- package/lib/types/events/domain-event.js.map +1 -1
- package/lib/types/events/quickstart-completed.js +3 -3
- package/lib/types/events/quickstart-completed.js.map +1 -1
- package/lib/types/events/quickstart-initiated.js +3 -3
- package/lib/types/events/quickstart-initiated.js.map +1 -1
- package/lib/types/events/sdk-publish-validation-failed.js +1 -1
- package/lib/types/events/sdk-publish-validation-failed.js.map +1 -1
- package/lib/types/file/directory.d.ts +4 -9
- package/lib/types/file/directory.js +17 -65
- package/lib/types/file/directory.js.map +1 -1
- package/lib/types/file/directoryPath.d.ts +17 -0
- package/lib/types/file/directoryPath.js +47 -2
- package/lib/types/file/directoryPath.js.map +1 -1
- package/lib/types/file/fileName.d.ts +8 -0
- package/lib/types/file/fileName.js +28 -6
- package/lib/types/file/fileName.js.map +1 -1
- package/lib/types/file/filePath.d.ts +18 -2
- package/lib/types/file/filePath.js +39 -4
- package/lib/types/file/filePath.js.map +1 -1
- package/lib/types/file/resource-input.js +1 -2
- package/lib/types/file/resource-input.js.map +1 -1
- package/lib/types/file/urlPath.js +2 -1
- package/lib/types/file/urlPath.js.map +1 -1
- package/lib/types/flags-provider.js +22 -22
- package/lib/types/flags-provider.js.map +1 -1
- package/lib/types/package-settings-context.js +2 -1
- package/lib/types/package-settings-context.js.map +1 -1
- package/lib/types/plugin/plugin-config.d.ts +10 -50
- package/lib/types/plugin/plugin-config.js +7 -1
- package/lib/types/plugin/plugin-config.js.map +1 -1
- package/lib/types/plugin-config-context.d.ts +30 -37
- package/lib/types/plugin-config-context.js +108 -139
- package/lib/types/plugin-config-context.js.map +1 -1
- package/lib/types/plugin-context.js +3 -2
- package/lib/types/plugin-context.js.map +1 -1
- package/lib/types/portal/code-samples.d.ts +27 -0
- package/lib/types/portal/code-samples.js +67 -0
- package/lib/types/portal/code-samples.js.map +1 -0
- package/lib/types/portal/config/ai-config.d.ts +15 -0
- package/lib/types/portal/config/ai-config.js +26 -0
- package/lib/types/portal/config/ai-config.js.map +1 -0
- package/lib/types/portal/config/brand-config.d.ts +55 -0
- package/lib/types/portal/config/brand-config.js +105 -0
- package/lib/types/portal/config/brand-config.js.map +1 -0
- package/lib/types/portal/config/color.d.ts +19 -0
- package/lib/types/portal/config/color.js +43 -0
- package/lib/types/portal/config/color.js.map +1 -0
- package/lib/types/portal/config/fields.d.ts +23 -0
- package/lib/types/portal/config/fields.js +67 -0
- package/lib/types/portal/config/fields.js.map +1 -0
- package/lib/types/portal/config/link.d.ts +18 -0
- package/lib/types/portal/config/link.js +72 -0
- package/lib/types/portal/config/link.js.map +1 -0
- package/lib/types/portal/config/navigation-config.d.ts +13 -0
- package/lib/types/portal/config/navigation-config.js +30 -0
- package/lib/types/portal/config/navigation-config.js.map +1 -0
- package/lib/types/portal/config/site-config.d.ts +32 -0
- package/lib/types/portal/config/site-config.js +88 -0
- package/lib/types/portal/config/site-config.js.map +1 -0
- package/lib/types/portal/config/static-asset.d.ts +25 -0
- package/lib/types/portal/config/static-asset.js +77 -0
- package/lib/types/portal/config/static-asset.js.map +1 -0
- package/lib/types/portal/content-notices.d.ts +20 -0
- package/lib/types/portal/content-notices.js +2 -0
- package/lib/types/portal/content-notices.js.map +1 -0
- package/lib/types/portal/content-tree.d.ts +103 -0
- package/lib/types/portal/content-tree.js +344 -0
- package/lib/types/portal/content-tree.js.map +1 -0
- package/lib/types/portal/endpoint.d.ts +6 -0
- package/lib/types/portal/endpoint.js +12 -0
- package/lib/types/portal/endpoint.js.map +1 -0
- package/lib/types/portal/generated-pages.d.ts +68 -0
- package/lib/types/portal/generated-pages.js +111 -0
- package/lib/types/portal/generated-pages.js.map +1 -0
- package/lib/types/portal/generation-status.d.ts +31 -0
- package/lib/types/portal/generation-status.js +26 -0
- package/lib/types/portal/generation-status.js.map +1 -0
- package/lib/types/portal/openapi-document.d.ts +48 -0
- package/lib/types/portal/openapi-document.js +138 -0
- package/lib/types/portal/openapi-document.js.map +1 -0
- package/lib/types/portal/page-fragments.d.ts +13 -0
- package/lib/types/portal/page-fragments.js +24 -0
- package/lib/types/portal/page-fragments.js.map +1 -0
- package/lib/types/portal/page-template.d.ts +15 -0
- package/lib/types/portal/page-template.js +64 -0
- package/lib/types/portal/page-template.js.map +1 -0
- package/lib/types/portal/page.d.ts +24 -0
- package/lib/types/portal/page.js +100 -0
- package/lib/types/portal/page.js.map +1 -0
- package/lib/types/portal/portal-artifacts.d.ts +25 -0
- package/lib/types/portal/portal-artifacts.js +30 -0
- package/lib/types/portal/portal-artifacts.js.map +1 -0
- package/lib/types/portal/portal-config.d.ts +69 -0
- package/lib/types/portal/portal-config.js +105 -0
- package/lib/types/portal/portal-config.js.map +1 -0
- package/lib/types/portal/portal-downloads.d.ts +8 -0
- package/lib/types/portal/portal-downloads.js +14 -0
- package/lib/types/portal/portal-downloads.js.map +1 -0
- package/lib/types/portal/portal-languages.d.ts +15 -0
- package/lib/types/portal/portal-languages.js +45 -0
- package/lib/types/portal/portal-languages.js.map +1 -0
- package/lib/types/portal/portal-navigation.d.ts +65 -0
- package/lib/types/portal/portal-navigation.js +217 -0
- package/lib/types/portal/portal-navigation.js.map +1 -0
- package/lib/types/portal/portal-sdk.d.ts +15 -0
- package/lib/types/portal/portal-sdk.js +28 -0
- package/lib/types/portal/portal-sdk.js.map +1 -0
- package/lib/types/portal/portal-source.d.ts +129 -0
- package/lib/types/portal/portal-source.js +2 -0
- package/lib/types/portal/portal-source.js.map +1 -0
- package/lib/types/portal/portal-stylesheet.d.ts +19 -0
- package/lib/types/portal/portal-stylesheet.js +40 -0
- package/lib/types/portal/portal-stylesheet.js.map +1 -0
- package/lib/types/portal/portal-tabs.d.ts +33 -0
- package/lib/types/portal/portal-tabs.js +38 -0
- package/lib/types/portal/portal-tabs.js.map +1 -0
- package/lib/types/portal/preview-config.d.ts +20 -0
- package/lib/types/portal/preview-config.js +32 -0
- package/lib/types/portal/preview-config.js.map +1 -0
- package/lib/types/portal/preview-content.d.ts +18 -0
- package/lib/types/portal/preview-content.js +50 -0
- package/lib/types/portal/preview-content.js.map +1 -0
- package/lib/types/portal/published-package.d.ts +12 -0
- package/lib/types/portal/published-package.js +35 -0
- package/lib/types/portal/published-package.js.map +1 -0
- package/lib/types/portal/unknown-fields.d.ts +5 -0
- package/lib/types/portal/unknown-fields.js +10 -0
- package/lib/types/portal/unknown-fields.js.map +1 -0
- package/lib/types/portal-context.d.ts +38 -6
- package/lib/types/portal-context.js +71 -24
- package/lib/types/portal-context.js.map +1 -1
- package/lib/types/portal-source-context.d.ts +77 -0
- package/lib/types/portal-source-context.js +408 -0
- package/lib/types/portal-source-context.js.map +1 -0
- package/lib/types/project-context.d.ts +49 -0
- package/lib/types/project-context.js +151 -0
- package/lib/types/project-context.js.map +1 -0
- package/lib/types/project-layout.d.ts +9 -0
- package/lib/types/project-layout.js +10 -0
- package/lib/types/project-layout.js.map +1 -0
- package/lib/types/publish/package-settings-configuration.d.ts +2 -0
- package/lib/types/publish/profile-id.js +1 -0
- package/lib/types/publish/profile-id.js.map +1 -1
- package/lib/types/publish/publishing-profile.d.ts +3 -1
- package/lib/types/publish/publishing-profile.js +33 -15
- package/lib/types/publish/publishing-profile.js.map +1 -1
- package/lib/types/publish/publishing-profiles.js +2 -1
- package/lib/types/publish/publishing-profiles.js.map +1 -1
- package/lib/types/publish/version.js +1 -0
- package/lib/types/publish/version.js.map +1 -1
- package/lib/types/resource-context.js +3 -2
- package/lib/types/resource-context.js.map +1 -1
- package/lib/types/sdk/generate.d.ts +22 -16
- package/lib/types/sdk/generate.js +64 -41
- package/lib/types/sdk/generate.js.map +1 -1
- package/lib/types/sdk/stability-choice.d.ts +12 -0
- package/lib/types/sdk/stability-choice.js +24 -0
- package/lib/types/sdk/stability-choice.js.map +1 -0
- package/lib/types/sdk-context.d.ts +4 -5
- package/lib/types/sdk-context.js +10 -18
- package/lib/types/sdk-context.js.map +1 -1
- package/lib/types/spec-context.d.ts +5 -4
- package/lib/types/spec-context.js +9 -8
- package/lib/types/spec-context.js.map +1 -1
- package/lib/types/temp-context.d.ts +1 -1
- package/lib/types/temp-context.js +5 -4
- package/lib/types/temp-context.js.map +1 -1
- package/lib/types/transform-context.d.ts +9 -5
- package/lib/types/transform-context.js +21 -18
- package/lib/types/transform-context.js.map +1 -1
- package/lib/utils/error-utils.d.ts +2 -0
- package/lib/utils/error-utils.js +5 -0
- package/lib/utils/error-utils.js.map +1 -0
- package/lib/utils/json-utils.d.ts +2 -0
- package/lib/utils/json-utils.js +4 -0
- package/lib/utils/json-utils.js.map +1 -0
- package/lib/utils/string-utils.d.ts +8 -1
- package/lib/utils/string-utils.js +13 -26
- package/lib/utils/string-utils.js.map +1 -1
- package/lib/utils/utils.d.ts +1 -3
- package/lib/utils/utils.js +12 -40
- package/lib/utils/utils.js.map +1 -1
- package/oclif.manifest.json +69 -357
- package/package.json +47 -25
- package/portal-pages/context-plugin.mdx +26 -0
- package/portal-pages/sdk.mdx +8 -0
- package/portal-pages/sdks.mdx +11 -0
- package/portal-template/NOTICE +37 -0
- package/portal-template/downloads.ts +41 -0
- package/portal-template/generated-pages-reload.ts +51 -0
- package/portal-template/package.json +11 -0
- package/portal-template/portal-config.ts +32 -0
- package/portal-template/prerender-pages.ts +81 -0
- package/portal-template/spec-reload.ts +26 -0
- package/portal-template/src/components/api-page.tsx +15 -0
- package/portal-template/src/components/code-block.tsx +9 -0
- package/portal-template/src/components/command-block.tsx +50 -0
- package/portal-template/src/components/example-layout.tsx +99 -0
- package/portal-template/src/components/logos.tsx +127 -0
- package/portal-template/src/components/mdx.tsx +28 -0
- package/portal-template/src/components/not-found.tsx +11 -0
- package/portal-template/src/components/plugin-install.tsx +22 -0
- package/portal-template/src/components/plugin-support.tsx +53 -0
- package/portal-template/src/components/sdk-actions.tsx +79 -0
- package/portal-template/src/components/sdk-cards.tsx +100 -0
- package/portal-template/src/components/search.tsx +41 -0
- package/portal-template/src/components/usage-tabs.tsx +92 -0
- package/portal-template/src/lib/code-samples.server.ts +40 -0
- package/portal-template/src/lib/code-samples.ts +43 -0
- package/portal-template/src/lib/code-titles.ts +29 -0
- package/portal-template/src/lib/install-command.ts +13 -0
- package/portal-template/src/lib/json.ts +5 -0
- package/portal-template/src/lib/layout.shared.tsx +41 -0
- package/portal-template/src/lib/layout.tsx +16 -0
- package/portal-template/src/lib/llms.server.ts +54 -0
- package/portal-template/src/lib/media-adapters.ts +34 -0
- package/portal-template/src/lib/navigation.ts +406 -0
- package/portal-template/src/lib/openapi-bundle.server.ts +343 -0
- package/portal-template/src/lib/openapi-filter.ts +191 -0
- package/portal-template/src/lib/openapi-labels.ts +15 -0
- package/portal-template/src/lib/openapi-methods.ts +12 -0
- package/portal-template/src/lib/openapi-section.server.ts +280 -0
- package/portal-template/src/lib/openapi-slim.ts +202 -0
- package/portal-template/src/lib/openapi.server.ts +16 -0
- package/portal-template/src/lib/portal-types.ts +36 -0
- package/portal-template/src/lib/portal.server.ts +13 -0
- package/portal-template/src/lib/portal.ts +11 -0
- package/portal-template/src/lib/rehype-code-titles.ts +53 -0
- package/portal-template/src/lib/request-examples.ts +72 -0
- package/portal-template/src/lib/seo.ts +21 -0
- package/portal-template/src/lib/shared.ts +51 -0
- package/portal-template/src/lib/shiki-bundle.ts +104 -0
- package/portal-template/src/lib/sitemap.server.ts +20 -0
- package/portal-template/src/lib/source.server.ts +27 -0
- package/portal-template/src/lib/source.ts +49 -0
- package/portal-template/src/lib/tabs.ts +37 -0
- package/portal-template/src/router.tsx +12 -0
- package/portal-template/src/routes/$.tsx +194 -0
- package/portal-template/src/routes/__root.tsx +56 -0
- package/portal-template/src/routes/api/search[.]json.ts +9 -0
- package/portal-template/src/routes/llms-full[.]txt.ts +10 -0
- package/portal-template/src/routes/llms[.]txt.ts +10 -0
- package/portal-template/src/routes/robots[.]txt.ts +10 -0
- package/portal-template/src/routes/sitemap[.]xml.ts +10 -0
- package/portal-template/src/routes/spa-shell.tsx +7 -0
- package/portal-template/src/routes/{$}[.]md.ts +21 -0
- package/portal-template/src/styles/app.css +33 -0
- package/portal-template/tsconfig.json +26 -0
- package/portal-template/vite.config.ts +68 -0
- package/lib/actions/plugin/record-sdk.d.ts +0 -14
- package/lib/actions/plugin/record-sdk.js +0 -60
- package/lib/actions/plugin/record-sdk.js.map +0 -1
- package/lib/actions/portal/copilot.d.ts +0 -17
- package/lib/actions/portal/copilot.js +0 -89
- package/lib/actions/portal/copilot.js.map +0 -1
- package/lib/actions/portal/quickstart.d.ts +0 -18
- package/lib/actions/portal/quickstart.js +0 -238
- package/lib/actions/portal/quickstart.js.map +0 -1
- package/lib/actions/portal/recipe/new-recipe.d.ts +0 -15
- package/lib/actions/portal/recipe/new-recipe.js +0 -177
- package/lib/actions/portal/recipe/new-recipe.js.map +0 -1
- package/lib/actions/portal/toc/new-toc.d.ts +0 -21
- package/lib/actions/portal/toc/new-toc.js +0 -95
- package/lib/actions/portal/toc/new-toc.js.map +0 -1
- package/lib/actions/sdk/merge-source-tree.d.ts +0 -12
- package/lib/actions/sdk/merge-source-tree.js +0 -78
- package/lib/actions/sdk/merge-source-tree.js.map +0 -1
- package/lib/actions/sdk/quickstart.d.ts +0 -18
- package/lib/actions/sdk/quickstart.js +0 -188
- package/lib/actions/sdk/quickstart.js.map +0 -1
- package/lib/actions/sdk/save-changes.d.ts +0 -8
- package/lib/actions/sdk/save-changes.js +0 -93
- package/lib/actions/sdk/save-changes.js.map +0 -1
- package/lib/application/portal/recipe/portal-recipe.d.ts +0 -8
- package/lib/application/portal/recipe/portal-recipe.js +0 -33
- package/lib/application/portal/recipe/portal-recipe.js.map +0 -1
- package/lib/application/portal/recipe/recipe-generator.d.ts +0 -21
- package/lib/application/portal/recipe/recipe-generator.js +0 -130
- package/lib/application/portal/recipe/recipe-generator.js.map +0 -1
- package/lib/application/portal/toc/toc-content-parser.d.ts +0 -5
- package/lib/application/portal/toc/toc-content-parser.js +0 -44
- package/lib/application/portal/toc/toc-content-parser.js.map +0 -1
- package/lib/application/portal/toc/toc-structure-generator.d.ts +0 -11
- package/lib/application/portal/toc/toc-structure-generator.js +0 -165
- package/lib/application/portal/toc/toc-structure-generator.js.map +0 -1
- package/lib/commands/portal/copilot.d.ts +0 -13
- package/lib/commands/portal/copilot.js +0 -34
- package/lib/commands/portal/copilot.js.map +0 -1
- package/lib/commands/portal/recipe/new.d.ts +0 -12
- package/lib/commands/portal/recipe/new.js +0 -45
- package/lib/commands/portal/recipe/new.js.map +0 -1
- package/lib/commands/portal/toc/new.d.ts +0 -16
- package/lib/commands/portal/toc/new.js +0 -68
- package/lib/commands/portal/toc/new.js.map +0 -1
- package/lib/commands/sdk/save-changes.d.ts +0 -14
- package/lib/commands/sdk/save-changes.js +0 -51
- package/lib/commands/sdk/save-changes.js.map +0 -1
- package/lib/infrastructure/debounce-service.d.ts +0 -10
- package/lib/infrastructure/debounce-service.js +0 -55
- package/lib/infrastructure/debounce-service.js.map +0 -1
- package/lib/infrastructure/services/portal-service.d.ts +0 -43
- package/lib/infrastructure/services/portal-service.js +0 -337
- package/lib/infrastructure/services/portal-service.js.map +0 -1
- package/lib/prompts/plugin/record-sdk.d.ts +0 -9
- package/lib/prompts/plugin/record-sdk.js +0 -40
- package/lib/prompts/plugin/record-sdk.js.map +0 -1
- package/lib/prompts/portal/copilot.d.ts +0 -18
- package/lib/prompts/portal/copilot.js +0 -82
- package/lib/prompts/portal/copilot.js.map +0 -1
- package/lib/prompts/portal/quickstart.d.ts +0 -42
- package/lib/prompts/portal/quickstart.js +0 -243
- package/lib/prompts/portal/quickstart.js.map +0 -1
- package/lib/prompts/portal/recipe/new-recipe.d.ts +0 -29
- package/lib/prompts/portal/recipe/new-recipe.js +0 -165
- package/lib/prompts/portal/recipe/new-recipe.js.map +0 -1
- package/lib/prompts/portal/toc/new-toc.d.ts +0 -16
- package/lib/prompts/portal/toc/new-toc.js +0 -50
- package/lib/prompts/portal/toc/new-toc.js.map +0 -1
- package/lib/prompts/sdk/merge-source-tree.d.ts +0 -22
- package/lib/prompts/sdk/merge-source-tree.js +0 -90
- package/lib/prompts/sdk/merge-source-tree.js.map +0 -1
- package/lib/prompts/sdk/quickstart.d.ts +0 -38
- package/lib/prompts/sdk/quickstart.js +0 -196
- package/lib/prompts/sdk/quickstart.js.map +0 -1
- package/lib/prompts/sdk/save-changes.d.ts +0 -21
- package/lib/prompts/sdk/save-changes.js +0 -84
- package/lib/prompts/sdk/save-changes.js.map +0 -1
- package/lib/types/build-context.d.ts +0 -26
- package/lib/types/build-context.js +0 -111
- package/lib/types/build-context.js.map +0 -1
- package/lib/types/events/recipe-creation-failed.d.ts +0 -5
- package/lib/types/events/recipe-creation-failed.js +0 -8
- package/lib/types/events/recipe-creation-failed.js.map +0 -1
- package/lib/types/events/sdk-changes-saved.d.ts +0 -8
- package/lib/types/events/sdk-changes-saved.js +0 -11
- package/lib/types/events/sdk-changes-saved.js.map +0 -1
- package/lib/types/events/sdk-changes-tracked.d.ts +0 -8
- package/lib/types/events/sdk-changes-tracked.js +0 -11
- package/lib/types/events/sdk-changes-tracked.js.map +0 -1
- package/lib/types/events/sdk-conflicts-resolved.d.ts +0 -8
- package/lib/types/events/sdk-conflicts-resolved.js +0 -11
- package/lib/types/events/sdk-conflicts-resolved.js.map +0 -1
- package/lib/types/events/toc-creation-failed.d.ts +0 -5
- package/lib/types/events/toc-creation-failed.js +0 -8
- package/lib/types/events/toc-creation-failed.js.map +0 -1
- package/lib/types/merge-source-tree-context.d.ts +0 -28
- package/lib/types/merge-source-tree-context.js +0 -63
- package/lib/types/merge-source-tree-context.js.map +0 -1
- package/lib/types/plugin/language-entry.d.ts +0 -9
- package/lib/types/plugin/language-entry.js +0 -64
- package/lib/types/plugin/language-entry.js.map +0 -1
- package/lib/types/recipe/recipe.d.ts +0 -22
- package/lib/types/recipe/recipe.js +0 -6
- package/lib/types/recipe/recipe.js.map +0 -1
- package/lib/types/recipe-context.d.ts +0 -9
- package/lib/types/recipe-context.js +0 -26
- package/lib/types/recipe-context.js.map +0 -1
- package/lib/types/save-changes-context.d.ts +0 -17
- package/lib/types/save-changes-context.js +0 -42
- package/lib/types/save-changes-context.js.map +0 -1
- package/lib/types/sdl/sdl.d.ts +0 -10
- package/lib/types/sdl/sdl.js +0 -18
- package/lib/types/sdl/sdl.js.map +0 -1
- package/lib/types/toc/toc-components.d.ts +0 -36
- package/lib/types/toc/toc-components.js +0 -94
- package/lib/types/toc/toc-components.js.map +0 -1
- package/lib/types/toc/toc.d.ts +0 -67
- package/lib/types/toc/toc.js +0 -2
- package/lib/types/toc/toc.js.map +0 -1
- package/lib/types/toc-context.d.ts +0 -12
- package/lib/types/toc-context.js +0 -26
- 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
|
[](https://npmjs.org/package/@apimatic/cli)
|
|
9
9
|
[](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
|
|
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: ./]
|
|
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>
|
|
71
|
-
--format=<option> (required)
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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
|
|
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
|
|
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
|
|
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/
|
|
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/
|
|
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
|
|
332
|
+
Generate a static API Documentation Portal.
|
|
316
333
|
|
|
317
334
|
```
|
|
318
335
|
USAGE
|
|
319
|
-
$ apimatic portal generate [-i <value>] [-d <value>] [-f] [
|
|
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
|
|
344
|
+
--zip write the generated portal as a .zip archive.
|
|
328
345
|
|
|
329
346
|
DESCRIPTION
|
|
330
|
-
Generate
|
|
347
|
+
Generate a static API Documentation Portal.
|
|
331
348
|
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
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
|
|
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
|
-
|
|
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
|
-
|
|
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
|
|
412
|
-
[--expand-webhooks] [--expand-callbacks]
|
|
371
|
+
$ apimatic portal serve [-p 23513] [-o] [-i <value>] [-k <value>]
|
|
413
372
|
|
|
414
373
|
FLAGS
|
|
415
|
-
-
|
|
416
|
-
|
|
417
|
-
-
|
|
418
|
-
|
|
419
|
-
|
|
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
|
-
|
|
381
|
+
Preview your API Documentation Portal with live reload.
|
|
430
382
|
|
|
431
|
-
|
|
432
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
|
441
|
-
|
|
442
|
-
apimatic portal toc new --input=./
|
|
393
|
+
apimatic portal serve
|
|
443
394
|
|
|
444
|
-
apimatic portal
|
|
395
|
+
apimatic portal serve --input=./ --port=23513 --open
|
|
445
396
|
```
|
|
446
397
|
|
|
447
|
-
_See code: [src/commands/portal/
|
|
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/
|
|
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
|
|
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
|
|
428
|
+
Create your first API Documentation Portal, SDKs and Context Plugins.
|
|
478
429
|
|
|
479
|
-
|
|
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/
|
|
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>] [--
|
|
494
|
-
[--
|
|
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:
|
|
508
|
-
<options:
|
|
509
|
-
--
|
|
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
|
|
519
|
-
|
|
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=
|
|
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/
|
|
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]
|
|
538
|
-
[-i <value>] [--publish-type package|sourcecode...] [--dry-run] [--codegen-version
|
|
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:
|
|
550
|
-
<options:
|
|
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>
|
|
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=
|
|
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/
|
|
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 -->
|