@apistudio/apim-cli/src/constants/command-constants.ts

CLI for API Management Products

/**
* Copyright Super iPaaS Integration LLC, an IBM Company 2024
*/
export const LOCALDIR_PATH = 'path of the local directory of the specified project asset. For example, C:\\local_dir';
export const DEPLOY_ALL = 'deploys all projects existing in the local directory';
export const ARCHIVE_PATH = 'deploys the specified archive. For example, C:\\dir\\build.zip';
export const GATEWAY_ENDPOINT = 'endpoint of the API Gateway instance to which the asset has to be deployed';
export const GATEWAY_USERNAME = 'username of the API Gateway instance to which the asset has to be deployed';
export const GATEWAY_CREDENTIAL = 'password of the API Gateway instance to which the asset has to be deployed';
export const GATEWAY_MCSP_TOKEN = 'mcsp token of the API Gateway instance to which the asset has to be deployed';
export const OVERWRITE_ASSETS = 'overwrites the existing assets on the API Gateway instance where the specified asset is being deployed';
export const DEPLOY_DESC = 'deploy the projects or the specified archive to API Gateway';
export const DEPLOY_ASSETS = 'deploys the specified api asset kind. For example, dev:paymentAPI:1.0';
export const BUILD_DESC = 'builds and archives the specified project assets';
export const BUILD_ALL = 'builds all projects existing in the local directory';
export const BUILD_ASSETS = 'builds the specified api asset kind. For example, dev:paymentAPI:1.0';
export const BUILD_OUTPUT = 'path where the output file should be stored. For example, C:\\dir\\build.zip'
export const DEBUG = 'enable debug mode';
export const DEPLOY= 'deploy the projects or the specified assets to API Gateway';
export const TEST_DESC = 'tests the specified project assets';
export const TEST_ALL ='tests all projects existing in the local directory';
export const TEST_ASSETS = 'tests the specified api asset kind. For example, dev:TestPaymentAPI:1.0';
export const ENV_DESC ='add or overwrites the environment configuration. For example, key1=value1,key2=value2...';
export const ENDPOINT='endpoints of the API in the project. For example, http://endpointURL1,https://endpointURL2...';

export const MIGRATION_DESC = 'migrate ATM tests to Studio kind tests';
export const MIGRATION_LOCALDIR_PATH = 'path to the local directory containing the specified folder or file, e.g., C:\local_dir.';
export const MIGRATION_OUTDIR_PATH = 'Path to the local directory where the output files will be saved, e.g., C:\\output_dir.';