@broadcom/endevor-for-zowe-cli
Version:
Endevor Plug-in for Zowe CLI
244 lines (240 loc) • 17.5 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.EndevorProfilesConfig = void 0;
const ApiConstants_1 = require("../../api/ApiConstants");
const EndevorConstants_1 = require("../../api/EndevorConstants");
const ActionArguments_1 = require("../../api/utils/doc/ActionArguments");
const CLIActionArguments_1 = require("../CLIActionArguments");
exports.EndevorProfilesConfig = [
{
type: "endevor",
schema: {
type: "object",
title: "The endevor profile",
description: "The endevor profile schema, where you specify your endevor session information and credentials",
properties: {
host: {
optionDefinition: {
description: "The hostname of the endevor session",
type: "string",
name: ActionArguments_1.args.host,
aliases: ["hostname"]
},
type: "string"
},
port: {
optionDefinition: {
description: "The port number of the endevor session",
type: "number",
name: ActionArguments_1.args.port,
aliases: ["p"]
},
type: "number",
includeInTemplate: true
},
user: {
optionDefinition: {
description: "The username of the endevor session",
type: "string",
name: ActionArguments_1.args.user,
aliases: ["username"]
},
secure: true,
type: "string"
},
password: {
optionDefinition: {
description: "The password of the user",
type: "string",
name: ActionArguments_1.args.password,
aliases: ["pass"]
},
secure: true,
type: "string"
},
protocol: {
optionDefinition: {
description: "The protocol used for connecting to Endevor Rest API",
type: "string",
name: ActionArguments_1.args.protocol,
aliases: ["prot"],
defaultValue: "https",
allowableValues: {
values: ["http", "https"],
caseSensitive: false
}
},
type: "string",
includeInTemplate: true
},
basePath: {
optionDefinition: {
description: "The base path used for connecting to Endevor Rest API",
type: "string",
name: ActionArguments_1.args["base-path"],
aliases: ["bp"],
defaultValue: ApiConstants_1.ApiConstants.BASE_PATH
},
type: "string"
},
rejectUnauthorized: {
optionDefinition: {
description: "If set, the server certificate is verified against the list of supplied CAs",
type: "boolean",
name: ActionArguments_1.args["reject-unauthorized"],
aliases: ["ru"]
},
type: "boolean"
},
reportDir: {
optionDefinition: {
description: "The default path where any reports will be written to, either absolute or relative to current directory",
type: "string",
name: CLIActionArguments_1.cliArgs["report-dir"],
aliases: ["rd"],
defaultValue: "."
},
type: "string"
}
}
}
},
{
type: "endevor-location",
schema: {
type: "object",
title: "The Endevor element inventory location specification profile",
description: "The Endevor element location, where you specify your working environment, system and subsystem",
properties: {
instance: {
optionDefinition: {
description: "The STC/datasource of the session",
type: "string",
name: ActionArguments_1.args.instance,
aliases: ["i"],
defaultValue: "ENDEVOR"
},
type: "string",
includeInTemplate: true
},
environment: {
optionDefinition: {
description: "The Endevor environment where your project resides",
type: "string",
name: ActionArguments_1.args.environment,
aliases: ["env"],
defaultValue: "DEV",
stringLengthRange: [1, EndevorConstants_1.EndevorConstants.INVENTORY_MAX_LEN]
},
type: "string",
includeInTemplate: true
},
system: {
optionDefinition: {
description: "The Endevor system where the element resides",
type: "string",
name: ActionArguments_1.args.system,
aliases: ["sys"],
stringLengthRange: [1, EndevorConstants_1.EndevorConstants.INVENTORY_MAX_LEN]
},
type: "string",
includeInTemplate: true
},
subsystem: {
optionDefinition: {
description: "The Endevor subsystem where your element resides",
type: "string",
name: ActionArguments_1.args.subsystem,
aliases: ["sub"],
stringLengthRange: [1, EndevorConstants_1.EndevorConstants.INVENTORY_MAX_LEN]
},
type: "string",
includeInTemplate: true
},
type: {
optionDefinition: {
description: "Name of the Endevor element's type",
type: "string",
name: ActionArguments_1.args.type,
aliases: ["typ"],
stringLengthRange: [1, EndevorConstants_1.EndevorConstants.INVENTORY_MAX_LEN]
},
type: "string",
includeInTemplate: true
},
stageNumber: {
optionDefinition: {
description: "The Endevor stage where your project resides",
type: "string",
name: ActionArguments_1.args["stage-number"],
aliases: ["sn"],
allowableValues: {
values: ["1", "2"]
}
},
type: "string",
includeInTemplate: true
},
comment: {
optionDefinition: {
description: "The Endevor comment you want to use when performing an action",
type: "string",
name: ActionArguments_1.args.comment,
aliases: ["com"],
stringLengthRange: [1, EndevorConstants_1.EndevorConstants.COMMENT_MAX_LEN]
},
type: "string"
},
ccid: {
optionDefinition: {
description: "The Endevor CCID you want to use when performing an action",
type: "string",
name: ActionArguments_1.args.ccid,
aliases: ["cci"],
stringLengthRange: [1, EndevorConstants_1.EndevorConstants.CCID_MAX_LEN]
},
type: "string"
},
maxrc: {
optionDefinition: {
description: "The return code of Endevor that defines a failed action",
type: "number",
name: CLIActionArguments_1.cliArgs.maxrc,
defaultValue: EndevorConstants_1.EndevorConstants.ENDEVOR_CAUTION_RC
},
type: "number",
includeInTemplate: true
},
"override-signout": {
optionDefinition: {
description: "Always override element signout, without having to specify the override signout option on each command",
type: "boolean",
name: ActionArguments_1.args["override-signout"],
aliases: ["os"],
defaultValue: false
},
type: "boolean"
},
"file-extension": {
optionDefinition: {
name: ActionArguments_1.args["file-extension"],
aliases: ["ext"],
description: `The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:
none: File name is equal to element name, no extension is added.
file-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.
type-name: The type name is used as the file extension.
mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead.`,
type: "string",
allowableValues: {
values: ["none", "type-name", "file-ext", "mixed"],
caseSensitive: false
},
defaultValue: "mixed"
},
type: "string"
}
}
}
}
];
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiRW5kZXZvclByb2ZpbGVzQ29uZmlnLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NsaS9wcm9maWxlcy9FbmRldm9yUHJvZmlsZXNDb25maWcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBd0JBLHlEQUFzRDtBQUN0RCxpRUFBOEQ7QUFDOUQseUVBQTJEO0FBQzNELDhEQUFnRDtBQUVuQyxRQUFBLHFCQUFxQixHQUF1QztJQUN2RTtRQUNFLElBQUksRUFBRSxTQUFTO1FBQ2YsTUFBTSxFQUFFO1lBQ04sSUFBSSxFQUFFLFFBQVE7WUFDZCxLQUFLLEVBQUUscUJBQXFCO1lBQzVCLFdBQVcsRUFBRSxnR0FBZ0c7WUFDN0csVUFBVSxFQUFFO2dCQUNWLElBQUksRUFBRTtvQkFDSixnQkFBZ0IsRUFBRTt3QkFDaEIsV0FBVyxFQUFFLHFDQUFxQzt3QkFDbEQsSUFBSSxFQUFFLFFBQVE7d0JBQ2QsSUFBSSxFQUFFLHNCQUFJLENBQUMsSUFBSTt3QkFDZixPQUFPLEVBQUUsQ0FBQyxVQUFVLENBQUM7cUJBQ3RCO29CQUNELElBQUksRUFBRSxRQUFRO2lCQUNmO2dCQUNELElBQUksRUFBRTtvQkFDSixnQkFBZ0IsRUFBRTt3QkFDaEIsV0FBVyxFQUFFLHdDQUF3Qzt3QkFDckQsSUFBSSxFQUFFLFFBQVE7d0JBQ2QsSUFBSSxFQUFFLHNCQUFJLENBQUMsSUFBSTt3QkFDZixPQUFPLEVBQUUsQ0FBQyxHQUFHLENBQUM7cUJBQ2Y7b0JBQ0QsSUFBSSxFQUFFLFFBQVE7b0JBQ2QsaUJBQWlCLEVBQUUsSUFBSTtpQkFDeEI7Z0JBQ0QsSUFBSSxFQUFFO29CQUNKLGdCQUFnQixFQUFFO3dCQUNoQixXQUFXLEVBQUUscUNBQXFDO3dCQUNsRCxJQUFJLEVBQUUsUUFBUTt3QkFDZCxJQUFJLEVBQUUsc0JBQUksQ0FBQyxJQUFJO3dCQUNmLE9BQU8sRUFBRSxDQUFDLFVBQVUsQ0FBQztxQkFDdEI7b0JBQ0QsTUFBTSxFQUFFLElBQUk7b0JBQ1osSUFBSSxFQUFFLFFBQVE7aUJBQ2Y7Z0JBQ0QsUUFBUSxFQUFFO29CQUNSLGdCQUFnQixFQUFFO3dCQUNoQixXQUFXLEVBQUUsMEJBQTBCO3dCQUN2QyxJQUFJLEVBQUUsUUFBUTt3QkFDZCxJQUFJLEVBQUUsc0JBQUksQ0FBQyxRQUFRO3dCQUNuQixPQUFPLEVBQUUsQ0FBQyxNQUFNLENBQUM7cUJBQ2xCO29CQUNELE1BQU0sRUFBRSxJQUFJO29CQUNaLElBQUksRUFBRSxRQUFRO2lCQUNmO2dCQUNELFFBQVEsRUFBRTtvQkFDUixnQkFBZ0IsRUFBRTt3QkFDaEIsV0FBVyxFQUFFLHNEQUFzRDt3QkFDbkUsSUFBSSxFQUFFLFFBQVE7d0JBQ2QsSUFBSSxFQUFFLHNCQUFJLENBQUMsUUFBUTt3QkFDbkIsT0FBTyxFQUFFLENBQUMsTUFBTSxDQUFDO3dCQUNqQixZQUFZLEVBQUUsT0FBTzt3QkFDckIsZUFBZSxFQUFFOzRCQUNmLE1BQU0sRUFBRSxDQUFDLE1BQU0sRUFBRSxPQUFPLENBQUM7NEJBQ3pCLGFBQWEsRUFBRSxLQUFLO3lCQUNyQjtxQkFDRjtvQkFDRCxJQUFJLEVBQUUsUUFBUTtvQkFDZCxpQkFBaUIsRUFBRSxJQUFJO2lCQUN4QjtnQkFDRCxRQUFRLEVBQUU7b0JBQ1IsZ0JBQWdCLEVBQUU7d0JBQ2hCLFdBQVcsRUFBRSx1REFBdUQ7d0JBQ3BFLElBQUksRUFBRSxRQUFRO3dCQUNkLElBQUksRUFBRSxzQkFBSSxDQUFDLFdBQVcsQ0FBQzt3QkFDdkIsT0FBTyxFQUFFLENBQUMsSUFBSSxDQUFDO3dCQUNmLFlBQVksRUFBRSwyQkFBWSxDQUFDLFNBQVM7cUJBQ3JDO29CQUNELElBQUksRUFBRSxRQUFRO2lCQUNmO2dCQUNELGtCQUFrQixFQUFFO29CQUNsQixnQkFBZ0IsRUFBRTt3QkFDaEIsV0FBVyxFQUFFLDZFQUE2RTt3QkFDMUYsSUFBSSxFQUFFLFNBQVM7d0JBQ2YsSUFBSSxFQUFFLHNCQUFJLENBQUMscUJBQXFCLENBQUM7d0JBQ2pDLE9BQU8sRUFBRSxDQUFDLElBQUksQ0FBQztxQkFDaEI7b0JBQ0QsSUFBSSxFQUFFLFNBQVM7aUJBQ2hCO2dCQUNELFNBQVMsRUFBRTtvQkFDVCxnQkFBZ0IsRUFBRTt3QkFDaEIsV0FBVyxFQUNULHlHQUF5Rzt3QkFDM0csSUFBSSxFQUFFLFFBQVE7d0JBQ2QsSUFBSSxFQUFFLDRCQUFPLENBQUMsWUFBWSxDQUFDO3dCQUMzQixPQUFPLEVBQUUsQ0FBQyxJQUFJLENBQUM7d0JBQ2YsWUFBWSxFQUFFLEdBQUc7cUJBQ2xCO29CQUNELElBQUksRUFBRSxRQUFRO2lCQUNmO2FBQ0Y7U0FFRjtLQUNGO0lBQ0Q7UUFDRSxJQUFJLEVBQUUsa0JBQWtCO1FBQ3hCLE1BQU0sRUFBRTtZQUNOLElBQUksRUFBRSxRQUFRO1lBQ2QsS0FBSyxFQUFFLDhEQUE4RDtZQUNyRSxXQUFXLEVBQUUsZ0dBQWdHO1lBQzdHLFVBQVUsRUFBRTtnQkFDVixRQUFRLEVBQUU7b0JBQ1IsZ0JBQWdCLEVBQUU7d0JBQ2hCLFdBQVcsRUFBRSxtQ0FBbUM7d0JBQ2hELElBQUksRUFBRSxRQUFRO3dCQUNkLElBQUksRUFBRSxzQkFBSSxDQUFDLFFBQVE7d0JBQ25CLE9BQU8sRUFBRSxDQUFDLEdBQUcsQ0FBQzt3QkFDZCxZQUFZLEVBQUUsU0FBUztxQkFDeEI7b0JBQ0QsSUFBSSxFQUFFLFFBQVE7b0JBQ2QsaUJBQWlCLEVBQUUsSUFBSTtpQkFDeEI7Z0JBQ0QsV0FBVyxFQUFFO29CQUNYLGdCQUFnQixFQUFFO3dCQUNoQixXQUFXLEVBQUUsb0RBQW9EO3dCQUNqRSxJQUFJLEVBQUUsUUFBUTt3QkFDZCxJQUFJLEVBQUUsc0JBQUksQ0FBQyxXQUFXO3dCQUN0QixPQUFPLEVBQUUsQ0FBQyxLQUFLLENBQUM7d0JBQ2hCLFlBQVksRUFBRSxLQUFLO3dCQUNuQixpQkFBaUIsRUFBRSxDQUFDLENBQUMsRUFBRSxtQ0FBZ0IsQ0FBQyxpQkFBaUIsQ0FBQztxQkFDM0Q7b0JBQ0QsSUFBSSxFQUFFLFFBQVE7b0JBQ2QsaUJBQWlCLEVBQUUsSUFBSTtpQkFDeEI7Z0JBQ0QsTUFBTSxFQUFFO29CQUNOLGdCQUFnQixFQUFFO3dCQUNoQixXQUFXLEVBQUUsOENBQThDO3dCQUMzRCxJQUFJLEVBQUUsUUFBUTt3QkFDZCxJQUFJLEVBQUUsc0JBQUksQ0FBQyxNQUFNO3dCQUNqQixPQUFPLEVBQUUsQ0FBQyxLQUFLLENBQUM7d0JBQ2hCLGlCQUFpQixFQUFFLENBQUMsQ0FBQyxFQUFFLG1DQUFnQixDQUFDLGlCQUFpQixDQUFDO3FCQUMzRDtvQkFDRCxJQUFJLEVBQUUsUUFBUTtvQkFDZCxpQkFBaUIsRUFBRSxJQUFJO2lCQUN4QjtnQkFDRCxTQUFTLEVBQUU7b0JBQ1QsZ0JBQWdCLEVBQUU7d0JBQ2hCLFdBQVcsRUFBRSxrREFBa0Q7d0JBQy9ELElBQUksRUFBRSxRQUFRO3dCQUNkLElBQUksRUFBRSxzQkFBSSxDQUFDLFNBQVM7d0JBQ3BCLE9BQU8sRUFBRSxDQUFDLEtBQUssQ0FBQzt3QkFDaEIsaUJBQWlCLEVBQUUsQ0FBQyxDQUFDLEVBQUUsbUNBQWdCLENBQUMsaUJBQWlCLENBQUM7cUJBQzNEO29CQUNELElBQUksRUFBRSxRQUFRO29CQUNkLGlCQUFpQixFQUFFLElBQUk7aUJBQ3hCO2dCQUNELElBQUksRUFBRTtvQkFDSixnQkFBZ0IsRUFBRTt3QkFDaEIsV0FBVyxFQUFFLG9DQUFvQzt3QkFDakQsSUFBSSxFQUFFLFFBQVE7d0JBQ2QsSUFBSSxFQUFFLHNCQUFJLENBQUMsSUFBSTt3QkFDZixPQUFPLEVBQUUsQ0FBQyxLQUFLLENBQUM7d0JBQ2hCLGlCQUFpQixFQUFFLENBQUMsQ0FBQyxFQUFFLG1DQUFnQixDQUFDLGlCQUFpQixDQUFDO3FCQUMzRDtvQkFDRCxJQUFJLEVBQUUsUUFBUTtvQkFDZCxpQkFBaUIsRUFBRSxJQUFJO2lCQUN4QjtnQkFDRCxXQUFXLEVBQUU7b0JBQ1gsZ0JBQWdCLEVBQUU7d0JBQ2hCLFdBQVcsRUFBRSw4Q0FBOEM7d0JBQzNELElBQUksRUFBRSxRQUFRO3dCQUNkLElBQUksRUFBRSxzQkFBSSxDQUFDLGNBQWMsQ0FBQzt3QkFDMUIsT0FBTyxFQUFFLENBQUMsSUFBSSxDQUFDO3dCQUNmLGVBQWUsRUFBRTs0QkFDZixNQUFNLEVBQUUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDO3lCQUNuQjtxQkFDRjtvQkFDRCxJQUFJLEVBQUUsUUFBUTtvQkFDZCxpQkFBaUIsRUFBRSxJQUFJO2lCQUN4QjtnQkFDRCxPQUFPLEVBQUU7b0JBQ1AsZ0JBQWdCLEVBQUU7d0JBQ2hCLFdBQVcsRUFBRSwrREFBK0Q7d0JBQzVFLElBQUksRUFBRSxRQUFRO3dCQUNkLElBQUksRUFBRSxzQkFBSSxDQUFDLE9BQU87d0JBQ2xCLE9BQU8sRUFBRSxDQUFDLEtBQUssQ0FBQzt3QkFDaEIsaUJBQWlCLEVBQUUsQ0FBQyxDQUFDLEVBQUUsbUNBQWdCLENBQUMsZUFBZSxDQUFDO3FCQUN6RDtvQkFDRCxJQUFJLEVBQUUsUUFBUTtpQkFDZjtnQkFDRCxJQUFJLEVBQUU7b0JBQ0osZ0JBQWdCLEVBQUU7d0JBQ2hCLFdBQVcsRUFBRSw0REFBNEQ7d0JBQ3pFLElBQUksRUFBRSxRQUFRO3dCQUNkLElBQUksRUFBRSxzQkFBSSxDQUFDLElBQUk7d0JBQ2YsT0FBTyxFQUFFLENBQUMsS0FBSyxDQUFDO3dCQUNoQixpQkFBaUIsRUFBRSxDQUFDLENBQUMsRUFBRSxtQ0FBZ0IsQ0FBQyxZQUFZLENBQUM7cUJBQ3REO29CQUNELElBQUksRUFBRSxRQUFRO2lCQUNmO2dCQUNELEtBQUssRUFBRTtvQkFDTCxnQkFBZ0IsRUFBRTt3QkFDaEIsV0FBVyxFQUFFLHlEQUF5RDt3QkFDdEUsSUFBSSxFQUFFLFFBQVE7d0JBQ2QsSUFBSSxFQUFFLDRCQUFPLENBQUMsS0FBSzt3QkFDbkIsWUFBWSxFQUFFLG1DQUFnQixDQUFDLGtCQUFrQjtxQkFDbEQ7b0JBQ0QsSUFBSSxFQUFFLFFBQVE7b0JBQ2QsaUJBQWlCLEVBQUUsSUFBSTtpQkFDeEI7Z0JBQ0Qsa0JBQWtCLEVBQUU7b0JBQ2xCLGdCQUFnQixFQUFFO3dCQUNoQixXQUFXLEVBQ1Qsd0dBQXdHO3dCQUMxRyxJQUFJLEVBQUUsU0FBUzt3QkFDZixJQUFJLEVBQUUsc0JBQUksQ0FBQyxrQkFBa0IsQ0FBQzt3QkFDOUIsT0FBTyxFQUFFLENBQUMsSUFBSSxDQUFDO3dCQUNmLFlBQVksRUFBRSxLQUFLO3FCQUNwQjtvQkFDRCxJQUFJLEVBQUUsU0FBUztpQkFDaEI7Z0JBQ0QsZ0JBQWdCLEVBQUU7b0JBQ2hCLGdCQUFnQixFQUFFO3dCQUNoQixJQUFJLEVBQUUsc0JBQUksQ0FBQyxnQkFBZ0IsQ0FBQzt3QkFDNUIsT0FBTyxFQUFFLENBQUMsS0FBSyxDQUFDO3dCQUNoQixXQUFXLEVBQUU7Ozs7Ozs7O3lIQVFnRzt3QkFDN0csSUFBSSxFQUFFLFFBQVE7d0JBQ2QsZUFBZSxFQUFFOzRCQUNmLE1BQU0sRUFBRSxDQUFDLE1BQU0sRUFBRSxXQUFXLEVBQUUsVUFBVSxFQUFFLE9BQU8sQ0FBQzs0QkFDbEQsYUFBYSxFQUFFLEtBQUs7eUJBQ3JCO3dCQUNELFlBQVksRUFBRSxPQUFPO3FCQUN0QjtvQkFDRCxJQUFJLEVBQUUsUUFBUTtpQkFDZjthQUNGO1NBRUY7S0FFRjtDQUNGLENBQUMifQ==