@apimatic/cli 1.5.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/oclif.manifest.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"quickstart": {
|
|
4
4
|
"aliases": [],
|
|
5
5
|
"args": {},
|
|
6
|
-
"description": "
|
|
6
|
+
"description": "Point the CLI at your API specification and it builds a documentation portal, SDKs, and a context plugin that teaches an AI coding assistant to use them.",
|
|
7
7
|
"examples": [
|
|
8
8
|
"\u001b[94mapimatic\u001b[39m \u001b[2mquickstart\u001b[22m"
|
|
9
9
|
],
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"pluginName": "@apimatic/cli",
|
|
16
16
|
"pluginType": "core",
|
|
17
17
|
"strict": true,
|
|
18
|
-
"summary": "Create your first API Portal,
|
|
18
|
+
"summary": "Create your first API Documentation Portal, SDKs and Context Plugins.",
|
|
19
19
|
"enableJsonFlag": false,
|
|
20
20
|
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mquickstart\u001b[22m",
|
|
21
21
|
"isESM": true,
|
|
@@ -252,15 +252,22 @@
|
|
|
252
252
|
"status.js"
|
|
253
253
|
]
|
|
254
254
|
},
|
|
255
|
-
"
|
|
255
|
+
"portal:generate": {
|
|
256
256
|
"aliases": [],
|
|
257
257
|
"args": {},
|
|
258
|
-
"description": "
|
|
258
|
+
"description": "Builds a documentation portal from the OpenAPI documents and Markdown pages in your 'src' directory.\n\nThe portal is built on your machine and written as static files you can host anywhere. Configure it with 'src/apimatic.json', whose 'languages' block gives the portal a page for each SDK language, and whose 'plugin' block, or a 'pluginUrl' in its 'portal' block for a plugin hosted elsewhere, a page for the context plugin.",
|
|
259
259
|
"examples": [
|
|
260
|
-
"\u001b[94mapimatic\u001b[39m \u001b[
|
|
261
|
-
"\u001b[94mapimatic\u001b[39m \u001b[
|
|
260
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mgenerate\u001b[22m",
|
|
261
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mgenerate\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m./\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m./portal\u001b[22m",
|
|
262
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mgenerate\u001b[22m \u001b[32m--zip\u001b[39m"
|
|
262
263
|
],
|
|
263
264
|
"flags": {
|
|
265
|
+
"zip": {
|
|
266
|
+
"description": "write the generated portal as a .zip archive.",
|
|
267
|
+
"name": "zip",
|
|
268
|
+
"allowNo": false,
|
|
269
|
+
"type": "boolean"
|
|
270
|
+
},
|
|
264
271
|
"input": {
|
|
265
272
|
"char": "i",
|
|
266
273
|
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
@@ -271,7 +278,7 @@
|
|
|
271
278
|
},
|
|
272
279
|
"destination": {
|
|
273
280
|
"char": "d",
|
|
274
|
-
"description": "[default: <input>/
|
|
281
|
+
"description": "[default: <input>/portal] path where the portal will be generated.",
|
|
275
282
|
"name": "destination",
|
|
276
283
|
"hasDynamicHelp": false,
|
|
277
284
|
"multiple": false,
|
|
@@ -295,75 +302,48 @@
|
|
|
295
302
|
},
|
|
296
303
|
"hasDynamicHelp": false,
|
|
297
304
|
"hiddenAliases": [],
|
|
298
|
-
"id": "
|
|
305
|
+
"id": "portal:generate",
|
|
299
306
|
"pluginAlias": "@apimatic/cli",
|
|
300
307
|
"pluginName": "@apimatic/cli",
|
|
301
308
|
"pluginType": "core",
|
|
302
309
|
"strict": true,
|
|
303
|
-
"summary": "Generate a
|
|
310
|
+
"summary": "Generate a static API Documentation Portal.",
|
|
304
311
|
"enableJsonFlag": false,
|
|
305
|
-
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[
|
|
312
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mgenerate\u001b[22m",
|
|
306
313
|
"isESM": true,
|
|
307
314
|
"relativePath": [
|
|
308
315
|
"lib",
|
|
309
316
|
"commands",
|
|
310
|
-
"
|
|
317
|
+
"portal",
|
|
311
318
|
"generate.js"
|
|
312
319
|
]
|
|
313
320
|
},
|
|
314
|
-
"
|
|
321
|
+
"portal:serve": {
|
|
315
322
|
"aliases": [],
|
|
316
323
|
"args": {},
|
|
317
|
-
"description": "
|
|
324
|
+
"description": "Serves the portal described by 'src/apimatic.json' from your machine, reloading the browser as you edit the Markdown pages in 'src/content', reorder them in a 'nav.json', or change the 'portal', 'languages' or 'plugin' block of 'apimatic.json'.\n\nAdding a language or a 'plugin' block, adding or removing a page in 'src/content', creating 'src/static', or changing which documents are in 'src/spec', needs the preview restarted.\n\nNothing is written to disk; run 'apimatic portal generate' to produce the static files.",
|
|
318
325
|
"examples": [
|
|
319
|
-
"\u001b[94mapimatic\u001b[39m \u001b[
|
|
320
|
-
"\u001b[94mapimatic\u001b[39m \u001b[
|
|
326
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mserve\u001b[22m",
|
|
327
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mserve\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m./\u001b[22m \u001b[32m--port\u001b[39m=\u001b[2m23513\u001b[22m \u001b[32m--open\u001b[39m"
|
|
321
328
|
],
|
|
322
329
|
"flags": {
|
|
323
|
-
"
|
|
324
|
-
"char": "
|
|
325
|
-
"description": "
|
|
326
|
-
"name": "
|
|
330
|
+
"port": {
|
|
331
|
+
"char": "p",
|
|
332
|
+
"description": "port to serve the portal on.",
|
|
333
|
+
"name": "port",
|
|
334
|
+
"default": 23513,
|
|
327
335
|
"hasDynamicHelp": false,
|
|
336
|
+
"helpValue": "23513",
|
|
328
337
|
"multiple": false,
|
|
329
338
|
"type": "option"
|
|
330
339
|
},
|
|
331
|
-
"
|
|
332
|
-
"char": "
|
|
333
|
-
"description": "
|
|
334
|
-
"name": "
|
|
335
|
-
"
|
|
336
|
-
"
|
|
337
|
-
|
|
338
|
-
}
|
|
339
|
-
},
|
|
340
|
-
"hasDynamicHelp": false,
|
|
341
|
-
"hiddenAliases": [],
|
|
342
|
-
"id": "plugin:publish",
|
|
343
|
-
"pluginAlias": "@apimatic/cli",
|
|
344
|
-
"pluginName": "@apimatic/cli",
|
|
345
|
-
"pluginType": "core",
|
|
346
|
-
"strict": true,
|
|
347
|
-
"summary": "Print the git commands for publishing your context plugin to GitHub.",
|
|
348
|
-
"enableJsonFlag": false,
|
|
349
|
-
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mplugin\u001b[22m \u001b[2mpublish\u001b[22m",
|
|
350
|
-
"isESM": true,
|
|
351
|
-
"relativePath": [
|
|
352
|
-
"lib",
|
|
353
|
-
"commands",
|
|
354
|
-
"plugin",
|
|
355
|
-
"publish.js"
|
|
356
|
-
]
|
|
357
|
-
},
|
|
358
|
-
"portal:copilot": {
|
|
359
|
-
"aliases": [],
|
|
360
|
-
"args": {},
|
|
361
|
-
"description": "Displays available API Copilots associated with your account and allows you to select which one to integrate with your portal. Each APIMatic account includes one Copilot by default. The selected Copilot will be added to your \u001b[35m'APIMATIC-BUILD.json'\u001b[39m file",
|
|
362
|
-
"examples": [
|
|
363
|
-
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mcopilot\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m./\u001b[22m",
|
|
364
|
-
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mcopilot\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m./\u001b[22m \u001b[32m--disable\u001b[39m"
|
|
365
|
-
],
|
|
366
|
-
"flags": {
|
|
340
|
+
"open": {
|
|
341
|
+
"char": "o",
|
|
342
|
+
"description": "open the portal in the default browser.",
|
|
343
|
+
"name": "open",
|
|
344
|
+
"allowNo": false,
|
|
345
|
+
"type": "boolean"
|
|
346
|
+
},
|
|
367
347
|
"input": {
|
|
368
348
|
"char": "i",
|
|
369
349
|
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
@@ -372,19 +352,6 @@
|
|
|
372
352
|
"multiple": false,
|
|
373
353
|
"type": "option"
|
|
374
354
|
},
|
|
375
|
-
"disable": {
|
|
376
|
-
"description": "marks the API Copilot as disabled in the configuration",
|
|
377
|
-
"name": "disable",
|
|
378
|
-
"allowNo": false,
|
|
379
|
-
"type": "boolean"
|
|
380
|
-
},
|
|
381
|
-
"force": {
|
|
382
|
-
"char": "f",
|
|
383
|
-
"description": "overwrite changes without asking for user consent.",
|
|
384
|
-
"name": "force",
|
|
385
|
-
"allowNo": false,
|
|
386
|
-
"type": "boolean"
|
|
387
|
-
},
|
|
388
355
|
"auth-key": {
|
|
389
356
|
"char": "k",
|
|
390
357
|
"description": "override current authentication state with an authentication key.",
|
|
@@ -396,29 +363,29 @@
|
|
|
396
363
|
},
|
|
397
364
|
"hasDynamicHelp": false,
|
|
398
365
|
"hiddenAliases": [],
|
|
399
|
-
"id": "portal:
|
|
366
|
+
"id": "portal:serve",
|
|
400
367
|
"pluginAlias": "@apimatic/cli",
|
|
401
368
|
"pluginName": "@apimatic/cli",
|
|
402
369
|
"pluginType": "core",
|
|
403
370
|
"strict": true,
|
|
404
|
-
"summary": "
|
|
371
|
+
"summary": "Preview your API Documentation Portal with live reload.",
|
|
405
372
|
"enableJsonFlag": false,
|
|
406
|
-
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[
|
|
373
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mserve\u001b[22m",
|
|
407
374
|
"isESM": true,
|
|
408
375
|
"relativePath": [
|
|
409
376
|
"lib",
|
|
410
377
|
"commands",
|
|
411
378
|
"portal",
|
|
412
|
-
"
|
|
379
|
+
"serve.js"
|
|
413
380
|
]
|
|
414
381
|
},
|
|
415
|
-
"
|
|
382
|
+
"plugin:generate": {
|
|
416
383
|
"aliases": [],
|
|
417
384
|
"args": {},
|
|
418
|
-
"description": "Generate an
|
|
385
|
+
"description": "Generate a context plugin that teaches an AI coding assistant how to use your SDKs. Requires an input directory containing a `src` directory with your API specification — `apimatic.json` is created if it is not there. It asks for the plugin's name on the first run, and for its languages only when `apimatic.json` records none (`sdk publish` records them). Later runs read both from `apimatic.json` without asking.",
|
|
419
386
|
"examples": [
|
|
420
|
-
"\u001b[94mapimatic\u001b[39m \u001b[
|
|
421
|
-
"\u001b[94mapimatic\u001b[39m \u001b[
|
|
387
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mplugin\u001b[22m \u001b[2mgenerate\u001b[22m",
|
|
388
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mplugin\u001b[22m \u001b[2mgenerate\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m\"./\"\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m\"./plugin\"\u001b[22m"
|
|
422
389
|
],
|
|
423
390
|
"flags": {
|
|
424
391
|
"input": {
|
|
@@ -431,7 +398,7 @@
|
|
|
431
398
|
},
|
|
432
399
|
"destination": {
|
|
433
400
|
"char": "d",
|
|
434
|
-
"description": "[default: <input>/
|
|
401
|
+
"description": "[default: <input>/plugin] path where the plugin will be generated.",
|
|
435
402
|
"name": "destination",
|
|
436
403
|
"hasDynamicHelp": false,
|
|
437
404
|
"multiple": false,
|
|
@@ -444,12 +411,6 @@
|
|
|
444
411
|
"allowNo": false,
|
|
445
412
|
"type": "boolean"
|
|
446
413
|
},
|
|
447
|
-
"zip": {
|
|
448
|
-
"description": "Download the generated portal as a .zip archive",
|
|
449
|
-
"name": "zip",
|
|
450
|
-
"allowNo": false,
|
|
451
|
-
"type": "boolean"
|
|
452
|
-
},
|
|
453
414
|
"auth-key": {
|
|
454
415
|
"char": "k",
|
|
455
416
|
"description": "override current authentication state with an authentication key.",
|
|
@@ -461,41 +422,31 @@
|
|
|
461
422
|
},
|
|
462
423
|
"hasDynamicHelp": false,
|
|
463
424
|
"hiddenAliases": [],
|
|
464
|
-
"id": "
|
|
425
|
+
"id": "plugin:generate",
|
|
465
426
|
"pluginAlias": "@apimatic/cli",
|
|
466
427
|
"pluginName": "@apimatic/cli",
|
|
467
428
|
"pluginType": "core",
|
|
468
429
|
"strict": true,
|
|
469
|
-
"summary": "Generate
|
|
430
|
+
"summary": "Generate a context plugin for your SDKs.",
|
|
470
431
|
"enableJsonFlag": false,
|
|
471
|
-
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[
|
|
432
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mplugin\u001b[22m \u001b[2mgenerate\u001b[22m",
|
|
472
433
|
"isESM": true,
|
|
473
434
|
"relativePath": [
|
|
474
435
|
"lib",
|
|
475
436
|
"commands",
|
|
476
|
-
"
|
|
437
|
+
"plugin",
|
|
477
438
|
"generate.js"
|
|
478
439
|
]
|
|
479
440
|
},
|
|
480
|
-
"
|
|
441
|
+
"plugin:publish": {
|
|
481
442
|
"aliases": [],
|
|
482
443
|
"args": {},
|
|
483
|
-
"description": "
|
|
444
|
+
"description": "Print the commands that publish a generated context plugin to a GitHub repository. The commands are printed for you to run — this command never touches your repository.",
|
|
484
445
|
"examples": [
|
|
485
|
-
"\u001b[94mapimatic\u001b[39m \u001b[
|
|
486
|
-
"\u001b[94mapimatic\u001b[39m \u001b[
|
|
446
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mplugin\u001b[22m \u001b[2mpublish\u001b[22m",
|
|
447
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2mplugin\u001b[22m \u001b[2mpublish\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m\"./\"\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m\"./plugin\"\u001b[22m"
|
|
487
448
|
],
|
|
488
449
|
"flags": {
|
|
489
|
-
"port": {
|
|
490
|
-
"char": "p",
|
|
491
|
-
"description": "port to serve the portal.",
|
|
492
|
-
"name": "port",
|
|
493
|
-
"default": 23513,
|
|
494
|
-
"hasDynamicHelp": false,
|
|
495
|
-
"helpValue": "23513",
|
|
496
|
-
"multiple": false,
|
|
497
|
-
"type": "option"
|
|
498
|
-
},
|
|
499
450
|
"input": {
|
|
500
451
|
"char": "i",
|
|
501
452
|
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
@@ -506,58 +457,37 @@
|
|
|
506
457
|
},
|
|
507
458
|
"destination": {
|
|
508
459
|
"char": "d",
|
|
509
|
-
"description": "[default: <input>/
|
|
460
|
+
"description": "[default: <input>/plugin] path where the plugin was generated.",
|
|
510
461
|
"name": "destination",
|
|
511
462
|
"hasDynamicHelp": false,
|
|
512
463
|
"multiple": false,
|
|
513
464
|
"type": "option"
|
|
514
|
-
},
|
|
515
|
-
"open": {
|
|
516
|
-
"char": "o",
|
|
517
|
-
"description": "open the portal in the default browser.",
|
|
518
|
-
"name": "open",
|
|
519
|
-
"allowNo": false,
|
|
520
|
-
"type": "boolean"
|
|
521
|
-
},
|
|
522
|
-
"no-reload": {
|
|
523
|
-
"description": "disable hot reload.",
|
|
524
|
-
"name": "no-reload",
|
|
525
|
-
"allowNo": false,
|
|
526
|
-
"type": "boolean"
|
|
527
|
-
},
|
|
528
|
-
"auth-key": {
|
|
529
|
-
"char": "k",
|
|
530
|
-
"description": "override current authentication state with an authentication key.",
|
|
531
|
-
"name": "auth-key",
|
|
532
|
-
"hasDynamicHelp": false,
|
|
533
|
-
"multiple": false,
|
|
534
|
-
"type": "option"
|
|
535
465
|
}
|
|
536
466
|
},
|
|
537
467
|
"hasDynamicHelp": false,
|
|
538
468
|
"hiddenAliases": [],
|
|
539
|
-
"id": "
|
|
469
|
+
"id": "plugin:publish",
|
|
540
470
|
"pluginAlias": "@apimatic/cli",
|
|
541
471
|
"pluginName": "@apimatic/cli",
|
|
542
472
|
"pluginType": "core",
|
|
543
473
|
"strict": true,
|
|
544
|
-
"summary": "
|
|
474
|
+
"summary": "Print the git commands for publishing your context plugin to GitHub.",
|
|
545
475
|
"enableJsonFlag": false,
|
|
546
|
-
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[
|
|
476
|
+
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mplugin\u001b[22m \u001b[2mpublish\u001b[22m",
|
|
547
477
|
"isESM": true,
|
|
548
478
|
"relativePath": [
|
|
549
479
|
"lib",
|
|
550
480
|
"commands",
|
|
551
|
-
"
|
|
552
|
-
"
|
|
481
|
+
"plugin",
|
|
482
|
+
"publish.js"
|
|
553
483
|
]
|
|
554
484
|
},
|
|
555
485
|
"sdk:generate": {
|
|
556
486
|
"aliases": [],
|
|
557
487
|
"args": {},
|
|
558
|
-
"description": "Generate Software Development
|
|
488
|
+
"description": "Generate a Software Development Kit (SDK) from an API specification.\nC#, TypeScript and Python are available; Java, Ruby, Go and PHP are on their way.",
|
|
559
489
|
"examples": [
|
|
560
|
-
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mgenerate\u001b[22m \u001b[32m--language\u001b[39m=\u001b[
|
|
490
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mgenerate\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mtypescript\u001b[22m",
|
|
561
491
|
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mgenerate\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mcsharp\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m./\u001b[22m",
|
|
562
492
|
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mgenerate\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mpython\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m./sdk\u001b[22m \u001b[32m--zip\u001b[39m"
|
|
563
493
|
],
|
|
@@ -588,12 +518,6 @@
|
|
|
588
518
|
"multiple": false,
|
|
589
519
|
"type": "option"
|
|
590
520
|
},
|
|
591
|
-
"skip-changes": {
|
|
592
|
-
"description": "Do not apply the saved changes to the generated SDK",
|
|
593
|
-
"name": "skip-changes",
|
|
594
|
-
"allowNo": false,
|
|
595
|
-
"type": "boolean"
|
|
596
|
-
},
|
|
597
521
|
"api-version": {
|
|
598
522
|
"description": "Version of the API to use for SDK generation (if multiple versions exist)",
|
|
599
523
|
"name": "api-version",
|
|
@@ -607,28 +531,20 @@
|
|
|
607
531
|
"allowNo": false,
|
|
608
532
|
"type": "boolean"
|
|
609
533
|
},
|
|
610
|
-
"track-changes": {
|
|
611
|
-
"description": "Enable change tracking for SDK generation (only required for initial setup)",
|
|
612
|
-
"name": "track-changes",
|
|
613
|
-
"allowNo": false,
|
|
614
|
-
"type": "boolean"
|
|
615
|
-
},
|
|
616
534
|
"codegen-version": {
|
|
617
535
|
"description": "Version of the code generator to use",
|
|
618
536
|
"name": "codegen-version",
|
|
619
|
-
"default": "
|
|
537
|
+
"default": "v4",
|
|
620
538
|
"hasDynamicHelp": false,
|
|
621
539
|
"multiple": false,
|
|
622
540
|
"options": [
|
|
623
|
-
"v3",
|
|
624
541
|
"v4"
|
|
625
542
|
],
|
|
626
543
|
"type": "option"
|
|
627
544
|
},
|
|
628
545
|
"stability": {
|
|
629
|
-
"description": "Stability level of the generated SDK",
|
|
546
|
+
"description": "Stability level of the generated SDK. Defaults to the level the language offers.",
|
|
630
547
|
"name": "stability",
|
|
631
|
-
"default": "stable",
|
|
632
548
|
"hasDynamicHelp": false,
|
|
633
549
|
"multiple": false,
|
|
634
550
|
"options": [
|
|
@@ -686,9 +602,8 @@
|
|
|
686
602
|
"examples": [
|
|
687
603
|
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mpublish\u001b[22m",
|
|
688
604
|
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mpublish\u001b[22m \u001b[32m--profile-id\u001b[39m=\u001b[2ma1b2c3d4e5f6a1b2c3d4e5f6\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mtypescript\u001b[22m \u001b[32m--version\u001b[39m=\u001b[2m1.0.0\u001b[22m \u001b[32m--publish-type\u001b[39m=\u001b[2mpackage\u001b[22m \u001b[32m--publish-type\u001b[39m=\u001b[2msourcecode\u001b[22m",
|
|
689
|
-
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mpublish\u001b[22m \u001b[32m--profile-id\u001b[39m=\u001b[2mb2c3d4e5f6a1b2c3d4e5f6a1\u001b[22m \u001b[32m--language\u001b[39m=\u001b[
|
|
690
|
-
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mpublish\u001b[22m \u001b[32m--profile-id\u001b[39m=\u001b[2mc3d4e5f6a1b2c3d4e5f6a1b2\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mpython\u001b[22m \u001b[32m--version\u001b[39m=\u001b[2m1.0.0\u001b[22m \u001b[32m--publish-type\u001b[39m=\u001b[2mpackage\u001b[22m \u001b[32m--dry-run\u001b[39m"
|
|
691
|
-
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mpublish\u001b[22m \u001b[32m--profile-id\u001b[39m=\u001b[2md4e5f6a1b2c3d4e5f6a1b2c3\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mcsharp\u001b[22m \u001b[32m--version\u001b[39m=\u001b[2m1.0.0\u001b[22m \u001b[32m--publish-type\u001b[39m=\u001b[2mpackage\u001b[22m \u001b[32m--codegen-version\u001b[39m=\u001b[2mv4\u001b[22m \u001b[32m--stability\u001b[39m=\u001b[2mbeta\u001b[22m"
|
|
605
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mpublish\u001b[22m \u001b[32m--profile-id\u001b[39m=\u001b[2mb2c3d4e5f6a1b2c3d4e5f6a1\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mcsharp\u001b[22m \u001b[32m--version\u001b[39m=\u001b[2m2.0.0\u001b[22m \u001b[32m--publish-type\u001b[39m=\u001b[2msourcecode\u001b[22m",
|
|
606
|
+
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2mpublish\u001b[22m \u001b[32m--profile-id\u001b[39m=\u001b[2mc3d4e5f6a1b2c3d4e5f6a1b2\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mpython\u001b[22m \u001b[32m--version\u001b[39m=\u001b[2m1.0.0\u001b[22m \u001b[32m--publish-type\u001b[39m=\u001b[2mpackage\u001b[22m \u001b[32m--dry-run\u001b[39m"
|
|
692
607
|
],
|
|
693
608
|
"flags": {
|
|
694
609
|
"profile-id": {
|
|
@@ -727,7 +642,8 @@
|
|
|
727
642
|
"php",
|
|
728
643
|
"python",
|
|
729
644
|
"ruby",
|
|
730
|
-
"typescript"
|
|
645
|
+
"typescript",
|
|
646
|
+
"go"
|
|
731
647
|
],
|
|
732
648
|
"type": "option"
|
|
733
649
|
},
|
|
@@ -766,19 +682,17 @@
|
|
|
766
682
|
"codegen-version": {
|
|
767
683
|
"description": "Version of the code generator to use",
|
|
768
684
|
"name": "codegen-version",
|
|
769
|
-
"default": "
|
|
685
|
+
"default": "v4",
|
|
770
686
|
"hasDynamicHelp": false,
|
|
771
687
|
"multiple": false,
|
|
772
688
|
"options": [
|
|
773
|
-
"v3",
|
|
774
689
|
"v4"
|
|
775
690
|
],
|
|
776
691
|
"type": "option"
|
|
777
692
|
},
|
|
778
693
|
"stability": {
|
|
779
|
-
"description": "Stability level of the generated SDK",
|
|
694
|
+
"description": "Stability level of the generated SDK. Defaults to the level the language offers.",
|
|
780
695
|
"name": "stability",
|
|
781
|
-
"default": "stable",
|
|
782
696
|
"hasDynamicHelp": false,
|
|
783
697
|
"multiple": false,
|
|
784
698
|
"options": [
|
|
@@ -786,12 +700,6 @@
|
|
|
786
700
|
"beta"
|
|
787
701
|
],
|
|
788
702
|
"type": "option"
|
|
789
|
-
},
|
|
790
|
-
"update-plugin-config": {
|
|
791
|
-
"description": "Record the published SDK in 'plugin-config.json', creating the file if it does not exist. Interactive runs are asked instead.",
|
|
792
|
-
"name": "update-plugin-config",
|
|
793
|
-
"allowNo": false,
|
|
794
|
-
"type": "boolean"
|
|
795
703
|
}
|
|
796
704
|
},
|
|
797
705
|
"hasDynamicHelp": false,
|
|
@@ -812,202 +720,6 @@
|
|
|
812
720
|
"publish.js"
|
|
813
721
|
]
|
|
814
722
|
},
|
|
815
|
-
"sdk:save-changes": {
|
|
816
|
-
"aliases": [],
|
|
817
|
-
"args": {},
|
|
818
|
-
"description": "Requires an input directory with API specifications, a path to the updated SDK directory, and the programming language.",
|
|
819
|
-
"examples": [
|
|
820
|
-
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2msave-changes\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mcsharp\u001b[22m",
|
|
821
|
-
"\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2msave-changes\u001b[22m \u001b[32m--language\u001b[39m=\u001b[2mjava\u001b[22m \u001b[32m--sdk\u001b[39m=\u001b[2m./sdk\u001b[22m"
|
|
822
|
-
],
|
|
823
|
-
"flags": {
|
|
824
|
-
"language": {
|
|
825
|
-
"char": "l",
|
|
826
|
-
"description": "Programming language of the SDK",
|
|
827
|
-
"name": "language",
|
|
828
|
-
"required": true,
|
|
829
|
-
"hasDynamicHelp": false,
|
|
830
|
-
"multiple": false,
|
|
831
|
-
"options": [
|
|
832
|
-
"csharp",
|
|
833
|
-
"java",
|
|
834
|
-
"php",
|
|
835
|
-
"python",
|
|
836
|
-
"ruby",
|
|
837
|
-
"typescript",
|
|
838
|
-
"go"
|
|
839
|
-
],
|
|
840
|
-
"type": "option"
|
|
841
|
-
},
|
|
842
|
-
"sdk": {
|
|
843
|
-
"description": "[default: ./sdk/<language> | ./sdk/<api-version>/<language>] path to the folder containing the updated SDK.",
|
|
844
|
-
"name": "sdk",
|
|
845
|
-
"hasDynamicHelp": false,
|
|
846
|
-
"multiple": false,
|
|
847
|
-
"type": "option"
|
|
848
|
-
},
|
|
849
|
-
"api-version": {
|
|
850
|
-
"description": "Version of the API where changes should be saved (if multiple versions exist).",
|
|
851
|
-
"name": "api-version",
|
|
852
|
-
"hasDynamicHelp": false,
|
|
853
|
-
"multiple": false,
|
|
854
|
-
"type": "option"
|
|
855
|
-
},
|
|
856
|
-
"input": {
|
|
857
|
-
"char": "i",
|
|
858
|
-
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
859
|
-
"name": "input",
|
|
860
|
-
"hasDynamicHelp": false,
|
|
861
|
-
"multiple": false,
|
|
862
|
-
"type": "option"
|
|
863
|
-
}
|
|
864
|
-
},
|
|
865
|
-
"hasDynamicHelp": false,
|
|
866
|
-
"hiddenAliases": [],
|
|
867
|
-
"id": "sdk:save-changes",
|
|
868
|
-
"pluginAlias": "@apimatic/cli",
|
|
869
|
-
"pluginName": "@apimatic/cli",
|
|
870
|
-
"pluginType": "core",
|
|
871
|
-
"strict": true,
|
|
872
|
-
"summary": "Save customizations made to an auto-generated SDK",
|
|
873
|
-
"enableJsonFlag": false,
|
|
874
|
-
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2msdk\u001b[22m \u001b[2msave-changes\u001b[22m",
|
|
875
|
-
"isESM": true,
|
|
876
|
-
"relativePath": [
|
|
877
|
-
"lib",
|
|
878
|
-
"commands",
|
|
879
|
-
"sdk",
|
|
880
|
-
"save-changes.js"
|
|
881
|
-
]
|
|
882
|
-
},
|
|
883
|
-
"portal:recipe:new": {
|
|
884
|
-
"aliases": [],
|
|
885
|
-
"args": {},
|
|
886
|
-
"description": "This command adds a new API Recipe file to your documentation portal.\n\nTo learn more about API Recipes, visit:\n\u001b[4m\u001b[94mhttps://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/api-recipes\u001b[39m\u001b[24m",
|
|
887
|
-
"examples": [
|
|
888
|
-
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mrecipe\u001b[22m \u001b[2mnew\u001b[22m",
|
|
889
|
-
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mrecipe\u001b[22m \u001b[2mnew\u001b[22m \u001b[32m--name\u001b[39m=\u001b[2m'\"My API Recipe\"'\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m\"./\"\u001b[22m"
|
|
890
|
-
],
|
|
891
|
-
"flags": {
|
|
892
|
-
"name": {
|
|
893
|
-
"description": "name for the recipe",
|
|
894
|
-
"name": "name",
|
|
895
|
-
"hasDynamicHelp": false,
|
|
896
|
-
"multiple": false,
|
|
897
|
-
"type": "option"
|
|
898
|
-
},
|
|
899
|
-
"input": {
|
|
900
|
-
"char": "i",
|
|
901
|
-
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
902
|
-
"name": "input",
|
|
903
|
-
"hasDynamicHelp": false,
|
|
904
|
-
"multiple": false,
|
|
905
|
-
"type": "option"
|
|
906
|
-
},
|
|
907
|
-
"force": {
|
|
908
|
-
"char": "f",
|
|
909
|
-
"description": "overwrite changes without asking for user consent.",
|
|
910
|
-
"name": "force",
|
|
911
|
-
"allowNo": false,
|
|
912
|
-
"type": "boolean"
|
|
913
|
-
}
|
|
914
|
-
},
|
|
915
|
-
"hasDynamicHelp": false,
|
|
916
|
-
"hiddenAliases": [],
|
|
917
|
-
"id": "portal:recipe:new",
|
|
918
|
-
"pluginAlias": "@apimatic/cli",
|
|
919
|
-
"pluginName": "@apimatic/cli",
|
|
920
|
-
"pluginType": "core",
|
|
921
|
-
"strict": true,
|
|
922
|
-
"summary": "Add an API Recipe to your API documentation portal.",
|
|
923
|
-
"enableJsonFlag": false,
|
|
924
|
-
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mrecipe\u001b[22m \u001b[2mnew\u001b[22m",
|
|
925
|
-
"isESM": true,
|
|
926
|
-
"relativePath": [
|
|
927
|
-
"lib",
|
|
928
|
-
"commands",
|
|
929
|
-
"portal",
|
|
930
|
-
"recipe",
|
|
931
|
-
"new.js"
|
|
932
|
-
]
|
|
933
|
-
},
|
|
934
|
-
"portal:toc:new": {
|
|
935
|
-
"aliases": [],
|
|
936
|
-
"args": {},
|
|
937
|
-
"description": "This command generates a new Table of Contents (TOC) file used in the\ngeneration of your API documentation portal.\n\nThe output is a YAML file with the .yml extension.\n\nTo learn more about the TOC file and APIMatic build directory structure, visit:\n\u001b[4m\u001b[94mhttps://docs.apimatic.io/platform-api/#/http/guides/generating-on-prem-api-portal/overview-generating-api-portal\u001b[39m\u001b[24m",
|
|
938
|
-
"examples": [
|
|
939
|
-
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mtoc\u001b[22m \u001b[2mnew\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m./src/content/\u001b[22m",
|
|
940
|
-
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mtoc\u001b[22m \u001b[2mnew\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m./\u001b[22m",
|
|
941
|
-
"\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mtoc\u001b[22m \u001b[2mnew\u001b[22m \u001b[32m--input\u001b[39m=\u001b[2m./\u001b[22m \u001b[32m--destination\u001b[39m=\u001b[2m./src/content/\u001b[22m"
|
|
942
|
-
],
|
|
943
|
-
"flags": {
|
|
944
|
-
"destination": {
|
|
945
|
-
"char": "d",
|
|
946
|
-
"description": "[default: <input>/src/content] path where the toc.yml will be generated.",
|
|
947
|
-
"name": "destination",
|
|
948
|
-
"hasDynamicHelp": false,
|
|
949
|
-
"multiple": false,
|
|
950
|
-
"type": "option"
|
|
951
|
-
},
|
|
952
|
-
"input": {
|
|
953
|
-
"char": "i",
|
|
954
|
-
"description": "[default: ./] path to the parent directory containing the 'src' directory, which includes API specifications and configuration files.",
|
|
955
|
-
"name": "input",
|
|
956
|
-
"hasDynamicHelp": false,
|
|
957
|
-
"multiple": false,
|
|
958
|
-
"type": "option"
|
|
959
|
-
},
|
|
960
|
-
"force": {
|
|
961
|
-
"char": "f",
|
|
962
|
-
"description": "overwrite changes without asking for user consent.",
|
|
963
|
-
"name": "force",
|
|
964
|
-
"allowNo": false,
|
|
965
|
-
"type": "boolean"
|
|
966
|
-
},
|
|
967
|
-
"expand-endpoints": {
|
|
968
|
-
"description": "include individual entries for each endpoint in the generated \u001b[35m'toc.yml'\u001b[39m. Requires a valid API specification in the working directory.",
|
|
969
|
-
"name": "expand-endpoints",
|
|
970
|
-
"allowNo": false,
|
|
971
|
-
"type": "boolean"
|
|
972
|
-
},
|
|
973
|
-
"expand-models": {
|
|
974
|
-
"description": "include individual entries for each model in the generated \u001b[35m'toc.yml'\u001b[39m. Requires a valid API specification in the working directory.",
|
|
975
|
-
"name": "expand-models",
|
|
976
|
-
"allowNo": false,
|
|
977
|
-
"type": "boolean"
|
|
978
|
-
},
|
|
979
|
-
"expand-webhooks": {
|
|
980
|
-
"description": "include individual entries for each webhook in the generated \u001b[35m'toc.yml'\u001b[39m. Requires a valid API specification in the working directory.",
|
|
981
|
-
"name": "expand-webhooks",
|
|
982
|
-
"allowNo": false,
|
|
983
|
-
"type": "boolean"
|
|
984
|
-
},
|
|
985
|
-
"expand-callbacks": {
|
|
986
|
-
"description": "include individual entries for each callback in the generated \u001b[35m'toc.yml'\u001b[39m. Requires a valid API specification in the working directory.",
|
|
987
|
-
"name": "expand-callbacks",
|
|
988
|
-
"allowNo": false,
|
|
989
|
-
"type": "boolean"
|
|
990
|
-
}
|
|
991
|
-
},
|
|
992
|
-
"hasDynamicHelp": false,
|
|
993
|
-
"hiddenAliases": [],
|
|
994
|
-
"id": "portal:toc:new",
|
|
995
|
-
"pluginAlias": "@apimatic/cli",
|
|
996
|
-
"pluginName": "@apimatic/cli",
|
|
997
|
-
"pluginType": "core",
|
|
998
|
-
"strict": true,
|
|
999
|
-
"summary": "Generate a Table of Contents (TOC) file for your API documentation portal",
|
|
1000
|
-
"enableJsonFlag": false,
|
|
1001
|
-
"cmdTxt": "\u001b[94mapimatic\u001b[39m \u001b[2mportal\u001b[22m \u001b[2mtoc\u001b[22m \u001b[2mnew\u001b[22m",
|
|
1002
|
-
"isESM": true,
|
|
1003
|
-
"relativePath": [
|
|
1004
|
-
"lib",
|
|
1005
|
-
"commands",
|
|
1006
|
-
"portal",
|
|
1007
|
-
"toc",
|
|
1008
|
-
"new.js"
|
|
1009
|
-
]
|
|
1010
|
-
},
|
|
1011
723
|
"publishing:profile:list": {
|
|
1012
724
|
"aliases": [],
|
|
1013
725
|
"args": {},
|
|
@@ -1036,5 +748,5 @@
|
|
|
1036
748
|
]
|
|
1037
749
|
}
|
|
1038
750
|
},
|
|
1039
|
-
"version": "
|
|
751
|
+
"version": "2.0.0-beta.1"
|
|
1040
752
|
}
|