From 2b711043e908d67c6b75c02b880ee2bff8cf47de Mon Sep 17 00:00:00 2001 From: "Andrew W. Harn" Date: Fri, 12 Jan 2024 08:35:10 -0500 Subject: [PATCH 1/2] Update Broadcom conformant plug-ins Signed-off-by: Andrew W. Harn --- commandGroups/endevor-bridge-for-git.jsonc | 447 ++++++++++++++++++--- commandGroups/endevor.jsonc | 389 +++++++++++++++++- profiles/create/endevor-location.jsonc | 19 + profiles/update/endevor-location.jsonc | 21 + 4 files changed, 815 insertions(+), 61 deletions(-) diff --git a/commandGroups/endevor-bridge-for-git.jsonc b/commandGroups/endevor-bridge-for-git.jsonc index c6ee7bb..764731a 100644 --- a/commandGroups/endevor-bridge-for-git.jsonc +++ b/commandGroups/endevor-bridge-for-git.jsonc @@ -123,6 +123,9 @@ "implies": [ "endevor-stage-number" ], + "conflictsWith": [ + "json-file" + ], "group": "Options", "aliases": [] }, @@ -136,8 +139,19 @@ "implies": [ "read-only" ], + "conflictsWith": [ + "json-file" + ], "group": "Options" }, + { + "name": "only-work-environment", + "description": "If specified, only elements from the Endevor work environment will be synchronized.", + "type": "boolean", + "required": false, + "group": "Options", + "aliases": [] + }, { "name": "mapping-mode", "description": "Mapping mode of the mapping ('FULL', 'WORK_ENV_ONLY' or 'MIRROR')", @@ -162,21 +176,6 @@ "group": "Options", "aliases": [] }, - { - "name": "repository-check", - "description": "If set to allowNonEmpty, user can proceed with initialization of the branch even if the branch exists.", - "allowableValues": { - "values": [ - "REQUIRE_EMPTY", - "ALLOW_NON_EMPTY" - ] - }, - "type": "string", - "defaultValue": "REQUIRE_EMPTY", - "required": false, - "group": "Options", - "aliases": [] - }, { "name": "endevor-protocol", "aliases": [ @@ -469,9 +468,9 @@ "aliases": [ "b" ], - "description": "Name of the branch that will be added/removed.", + "description": "Name of the synchronized branch in the Git repository.", "type": "string", - "required": true + "defaultValue": "master" } ], "profile": { @@ -997,8 +996,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": false, - "group": "Options" + "required": true, + "group": "Required Options" }, { "name": "work-area-id", @@ -1387,8 +1386,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": false, - "group": "Options" + "required": true, + "group": "Required Options" }, { "name": "work-area-id", @@ -1860,8 +1859,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": false, - "group": "Options" + "required": true, + "group": "Required Options" }, { "name": "work-dir", @@ -3702,6 +3701,364 @@ ], "positionals": [] }, + { + "name": "endevor-credentials", + "aliases": [ + "ec" + ], + "summary": "Manage the stored Endevor credentials. [Deprecated]", + "description": "Manage your Endevor credentials stored in Endevor Bridge for Git. [Deprecated]", + "type": "group", + "children": [ + { + "name": "update", + "aliases": [ + "u" + ], + "type": "command", + "handler": "", + "description": "Update your Endevor credentials for a Git-Endevor mapping.", + "positionals": [ + { + "name": "context", + "description": "Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).", + "type": "string", + "required": true + }, + { + "name": "mapping", + "description": "Git-Endevor mapping name (ID of the Git repository).", + "type": "string", + "required": true + } + ], + "profile": { + "optional": [ + "ebg", + "endevor", + "base" + ] + }, + "options": [ + { + "name": "endevor-user", + "aliases": [ + "endevoru" + ], + "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", + "type": "string", + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" + }, + { + "name": "endevor-password", + "aliases": [ + "endevorpass", + "endevorpw" + ], + "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", + "type": "string", + "required": false, + "group": "Endevor options (alternatively use an 'endevor' profile)" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + } + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "The Endevor Bridge for Git hostname.", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "The Endevor Bridge for Git port.", + "type": "number", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "Endevor Bridge for Git username (your git username).", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "token", + "aliases": [ + "t" + ], + "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates. \n\nDefault value: false", + "type": "boolean", + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "ebg-profile", + "aliases": [ + "ebg-p" + ], + "group": "Profile Options", + "description": "The name of a (ebg) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Update the Endevor credentials for the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile", + "options": "MY-CONTEXT MY-MAPPING" + }, + { + "description": "Update the Endevor credentials for the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile but not using an Endevor profile", + "options": "MY-CONTEXT MY-MAPPING --endevor-user my-user --endevor-password my-password" + } + ], + "passOn": [], + "children": [] + } + ], + "passOn": [ + { + "property": "options", + "value": [ + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + } + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "The Endevor Bridge for Git hostname.", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "The Endevor Bridge for Git port.", + "type": "number", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "Endevor Bridge for Git username (your git username).", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "token", + "aliases": [ + "t" + ], + "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", + "type": "string", + "required": true, + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates. \n\nDefault value: false", + "type": "boolean", + "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" + } + ], + "merge": true + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [] + }, { "name": "local-hook-token", "aliases": [ @@ -4525,6 +4882,14 @@ "defaultValue": "master", "group": "Options" }, + { + "name": "only-work-environment", + "description": "If specified, only elements from the Endevor work environment will be synchronized.", + "type": "boolean", + "required": false, + "group": "Options", + "aliases": [] + }, { "name": "read-only", "description": "If specified, it is necessary to use the option --endevor-stage-number. The synchronized elements will be read-only.", @@ -4555,32 +4920,9 @@ "group": "Options" }, { - "name": "type-filters", - "description": "Type filters that your mapping will be using. There can be multiple separated by a space. eg --type-filters \"COBOL\" \"COPY\".", - "type": "array", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "name-filters", - "description": "Name filters that your mapping will be using. There can be multiple separated by a space. eg --name-filters \"ELE*\" \"CO*\".", - "type": "array", - "required": false, - "group": "Options", - "aliases": [] - }, - { - "name": "repository-check", - "description": "If set to allowNonEmpty, user can proceed with initialization even if the repository is not empty.", - "allowableValues": { - "values": [ - "REQUIRE_EMPTY", - "ALLOW_NON_EMPTY" - ] - }, + "name": "type-filter", + "description": "Type filter", "type": "string", - "defaultValue": "REQUIRE_EMPTY", "required": false, "group": "Options", "aliases": [] @@ -4615,6 +4957,7 @@ "read-only", "endevor-instance", "endevor-environment", + "endevor-environment", "endevor-system", "endevor-subsystem" ], @@ -6499,8 +6842,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": false, - "group": "Options" + "required": true, + "group": "Required Options" }, { "name": "work-dir", @@ -6765,8 +7108,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": false, - "group": "Options" + "required": true, + "group": "Required Options" }, { "name": "work-dir", diff --git a/commandGroups/endevor.jsonc b/commandGroups/endevor.jsonc index 4c46cc2..1cc0fc9 100644 --- a/commandGroups/endevor.jsonc +++ b/commandGroups/endevor.jsonc @@ -8946,6 +8946,348 @@ "passOn": [], "children": [] }, + { + "examples": [ + { + "options": "--host hostName --port 8080", + "description": "List codepage-config with session specified" + } + ], + "name": "code-page-config", + "aliases": [ + "codepages", + "cdpg" + ], + "description": "The list code-page-config command lists the EBCDIC code page mapping rules used by Endevor Web Services", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "endevor", + "endevor-location", + "base" + ] + }, + "options": [ + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "host", + "aliases": [ + "hostname" + ], + "description": "Specifies the base host name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "port", + "aliases": [ + "p" + ], + "description": "Specifies the port number.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "instance", + "aliases": [ + "i" + ], + "description": "Specifies Endevor Web Services dataSource name.", + "type": "string", + "group": "endevor-location definition options" + }, + { + "name": "protocol", + "aliases": [ + "prot" + ], + "description": "Specifies the protocol used for connecting to Endevor Rest API", + "type": "string", + "defaultValue": "https", + "allowableValues": { + "values": [ + "http", + "https" + ], + "caseSensitive": false + }, + "group": "endevor session definition options" + }, + { + "name": "user", + "aliases": [ + "username" + ], + "description": "Specifies the user name.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "Specifies the user's password.", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Specify this option to have the server certificate verified against the list of supplied CAs", + "type": "boolean", + "group": "endevor session definition options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "Specifies the base path used for connecting to Endevor Rest API", + "type": "string", + "group": "endevor session definition options" + }, + { + "name": "suppress-messages", + "aliases": [ + "sm" + ], + "description": "Suppress all [INFO]/[WARN] messages from terminal output.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "report-file", + "aliases": [ + "file-name" + ], + "description": "File name for saving reports from Endevor SCM locally.", + "type": "string", + "group": "output customization options" + }, + { + "name": "report-dir", + "description": "Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.", + "type": "string", + "group": "output customization options", + "aliases": [] + }, + { + "name": "write-report", + "description": "Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false", + "type": "boolean", + "group": "output customization options", + "aliases": [] + }, + { + "name": "full-output", + "aliases": [ + "fo" + ], + "description": "Specify this option if you want a full output of list action.", + "type": "boolean", + "group": "output customization options" + }, + { + "name": "asynchronous", + "aliases": [ + "async" + ], + "description": "Submit this command as an asynchronous Endevor Web Services task", + "type": "boolean", + "group": "asynchronous task options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "endevor-profile", + "aliases": [ + "endevor-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor) profile to load for this command execution.", + "type": "string" + }, + { + "name": "endevor-location-profile", + "aliases": [ + "endevor-location-p" + ], + "group": "Profile Options", + "description": "The name of a (endevor-location) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "response-format-filter", + "aliases": [ + "rff" + ], + "description": "Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.", + "type": "array", + "group": "Response Format Options" + }, + { + "name": "response-format-type", + "aliases": [ + "rft" + ], + "description": "The command response output format type. Must be one of the following:\n\ntable: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.\n\nlist: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.\n\nobject: Formats output data as a list of prettified objects (or single object). Can be used in place of \"table\" to change from tabular output to a list of prettified objects.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", + "type": "string", + "allowableValues": { + "values": [ + "table", + "list", + "object", + "string" + ], + "caseSensitive": false + }, + "group": "Response Format Options" + }, + { + "name": "response-format-header", + "aliases": [ + "rfh" + ], + "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", + "type": "boolean", + "group": "Response Format Options", + "defaultValue": null + } + ], + "outputFormatOptions": true, + "positionals": [], + "passOn": [], + "children": [] + }, { "examples": [ { @@ -15284,15 +15626,6 @@ "defaultValue": false, "group": "options" }, - { - "name": "asynchronous", - "aliases": [ - "async" - ], - "description": "Submit this command as an asynchronous Endevor Web Services task", - "type": "boolean", - "group": "asynchronous task options" - }, { "name": "to-file", "aliases": [ @@ -17498,6 +17831,25 @@ ], "group": "bulk action options" }, + { + "name": "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:\n\n none: File name is equal to element name, no extension is added.\n\n file-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.\n\n type-name: The type name is used as the file extension.\n\n mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead.", + "type": "string", + "allowableValues": { + "values": [ + "none", + "file-ext", + "type-name", + "mixed" + ], + "caseSensitive": false + }, + "defaultValue": "mixed", + "group": "bulk action options" + }, { "name": "host", "aliases": [ @@ -19921,6 +20273,25 @@ "type": "boolean", "group": "workspace options" }, + { + "name": "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:\n\n none: File name is equal to element name, no extension is added.\n\n file-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.\n\n type-name: The type name is used as the file extension.\n\n mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead.", + "type": "string", + "allowableValues": { + "values": [ + "none", + "file-ext", + "type-name", + "mixed" + ], + "caseSensitive": false + }, + "defaultValue": "mixed", + "group": "workspace options" + }, { "name": "host", "aliases": [ diff --git a/profiles/create/endevor-location.jsonc b/profiles/create/endevor-location.jsonc index 32b44cb..e74cd2d 100644 --- a/profiles/create/endevor-location.jsonc +++ b/profiles/create/endevor-location.jsonc @@ -144,6 +144,25 @@ "defaultValue": false, "group": "Options" }, + { + "name": "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:\n\n none: File name is equal to element name, no extension is added.\n\n file-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.\n\n type-name: The type name is used as the file extension.\n\n 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", + "group": "Options" + }, { "name": "overwrite", "aliases": [ diff --git a/profiles/update/endevor-location.jsonc b/profiles/update/endevor-location.jsonc index d46dc05..343d5e5 100644 --- a/profiles/update/endevor-location.jsonc +++ b/profiles/update/endevor-location.jsonc @@ -170,6 +170,27 @@ "implies": null, "group": "Options" }, + { + "name": "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:\n\n none: File name is equal to element name, no extension is added.\n\n file-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.\n\n type-name: The type name is used as the file extension.\n\n 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 + }, + "required": false, + "absenceImplications": null, + "implies": null, + "group": "Options" + }, { "name": "show-inputs-only", "group": "Global Options", From f0577a7a23d90fe5275d8f50c68604b0803bbaa9 Mon Sep 17 00:00:00 2001 From: Timothy Johnson Date: Fri, 12 Jan 2024 09:45:39 -0500 Subject: [PATCH 2/2] Update endevor-bridge-for-git command groups Signed-off-by: Timothy Johnson --- commandGroups/endevor-bridge-for-git.jsonc | 447 +++------------------ 1 file changed, 52 insertions(+), 395 deletions(-) diff --git a/commandGroups/endevor-bridge-for-git.jsonc b/commandGroups/endevor-bridge-for-git.jsonc index 764731a..c6ee7bb 100644 --- a/commandGroups/endevor-bridge-for-git.jsonc +++ b/commandGroups/endevor-bridge-for-git.jsonc @@ -123,9 +123,6 @@ "implies": [ "endevor-stage-number" ], - "conflictsWith": [ - "json-file" - ], "group": "Options", "aliases": [] }, @@ -139,19 +136,8 @@ "implies": [ "read-only" ], - "conflictsWith": [ - "json-file" - ], "group": "Options" }, - { - "name": "only-work-environment", - "description": "If specified, only elements from the Endevor work environment will be synchronized.", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, { "name": "mapping-mode", "description": "Mapping mode of the mapping ('FULL', 'WORK_ENV_ONLY' or 'MIRROR')", @@ -176,6 +162,21 @@ "group": "Options", "aliases": [] }, + { + "name": "repository-check", + "description": "If set to allowNonEmpty, user can proceed with initialization of the branch even if the branch exists.", + "allowableValues": { + "values": [ + "REQUIRE_EMPTY", + "ALLOW_NON_EMPTY" + ] + }, + "type": "string", + "defaultValue": "REQUIRE_EMPTY", + "required": false, + "group": "Options", + "aliases": [] + }, { "name": "endevor-protocol", "aliases": [ @@ -468,9 +469,9 @@ "aliases": [ "b" ], - "description": "Name of the synchronized branch in the Git repository.", + "description": "Name of the branch that will be added/removed.", "type": "string", - "defaultValue": "master" + "required": true } ], "profile": { @@ -996,8 +997,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": true, - "group": "Required Options" + "required": false, + "group": "Options" }, { "name": "work-area-id", @@ -1386,8 +1387,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": true, - "group": "Required Options" + "required": false, + "group": "Options" }, { "name": "work-area-id", @@ -1859,8 +1860,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": true, - "group": "Required Options" + "required": false, + "group": "Options" }, { "name": "work-dir", @@ -3701,364 +3702,6 @@ ], "positionals": [] }, - { - "name": "endevor-credentials", - "aliases": [ - "ec" - ], - "summary": "Manage the stored Endevor credentials. [Deprecated]", - "description": "Manage your Endevor credentials stored in Endevor Bridge for Git. [Deprecated]", - "type": "group", - "children": [ - { - "name": "update", - "aliases": [ - "u" - ], - "type": "command", - "handler": "", - "description": "Update your Endevor credentials for a Git-Endevor mapping.", - "positionals": [ - { - "name": "context", - "description": "Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).", - "type": "string", - "required": true - }, - { - "name": "mapping", - "description": "Git-Endevor mapping name (ID of the Git repository).", - "type": "string", - "required": true - } - ], - "profile": { - "optional": [ - "ebg", - "endevor", - "base" - ] - }, - "options": [ - { - "name": "endevor-user", - "aliases": [ - "endevoru" - ], - "description": "Mainframe (Endevor) username, which can be the same as your TSO login.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "endevor-password", - "aliases": [ - "endevorpass", - "endevorpw" - ], - "description": "Mainframe (Endevor) password, which can be the same as your TSO password.", - "type": "string", - "required": false, - "group": "Endevor options (alternatively use an 'endevor' profile)" - }, - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "show-inputs-only", - "group": "Global Options", - "description": "Show command inputs and do not run the command", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - }, - { - "name": "ebg-profile", - "aliases": [ - "ebg-p" - ], - "group": "Profile Options", - "description": "The name of a (ebg) profile to load for this command execution.", - "type": "string" - }, - { - "name": "endevor-profile", - "aliases": [ - "endevor-p" - ], - "group": "Profile Options", - "description": "The name of a (endevor) profile to load for this command execution.", - "type": "string" - }, - { - "name": "base-profile", - "aliases": [ - "base-p" - ], - "group": "Profile Options", - "description": "The name of a (base) profile to load for this command execution.", - "type": "string" - }, - { - "name": "password", - "aliases": [ - "pass", - "pw" - ], - "description": "Password to authenticate to service on the mainframe.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-type", - "aliases": [ - "tt" - ], - "description": "The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "token-value", - "aliases": [ - "tv" - ], - "description": "The value of the token to pass to the API.", - "type": "string", - "group": "Base Connection Options" - }, - { - "name": "cert-file", - "description": "The file path to a certificate file to use for authentication", - "type": "existingLocalFile", - "group": "Base Connection Options", - "aliases": [] - }, - { - "name": "cert-key-file", - "description": "The file path to a certificate key file to use for authentication", - "type": "existingLocalFile", - "group": "Base Connection Options", - "aliases": [] - } - ], - "examples": [ - { - "description": "Update the Endevor credentials for the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile", - "options": "MY-CONTEXT MY-MAPPING" - }, - { - "description": "Update the Endevor credentials for the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile but not using an Endevor profile", - "options": "MY-CONTEXT MY-MAPPING --endevor-user my-user --endevor-password my-password" - } - ], - "passOn": [], - "children": [] - } - ], - "passOn": [ - { - "property": "options", - "value": [ - { - "name": "protocol", - "aliases": [ - "prot" - ], - "description": "The Endevor Bridge for Git SCM protocol. \n\nDefault value: https", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)", - "defaultValue": "https", - "allowableValues": { - "values": [ - "http", - "https" - ], - "caseSensitive": false - } - }, - { - "name": "host", - "aliases": [ - "H" - ], - "description": "The Endevor Bridge for Git hostname.", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "port", - "aliases": [ - "P" - ], - "description": "The Endevor Bridge for Git port.", - "type": "number", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "user", - "aliases": [ - "u" - ], - "description": "Endevor Bridge for Git username (your git username).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "token", - "aliases": [ - "t" - ], - "description": "Git personal access token (it can be obtained from your Git Enterprise Server).", - "type": "string", - "required": true, - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - }, - { - "name": "reject-unauthorized", - "aliases": [ - "ru" - ], - "description": "Reject self-signed certificates. \n\nDefault value: false", - "type": "boolean", - "group": "Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)" - } - ], - "merge": true - } - ], - "options": [ - { - "name": "help-examples", - "group": "Global Options", - "description": "Display examples for all the commands in a group", - "type": "boolean", - "aliases": [] - }, - { - "name": "response-format-json", - "aliases": [ - "rfj" - ], - "group": "Global Options", - "description": "Produce JSON formatted data from a command", - "type": "boolean" - }, - { - "name": "help", - "aliases": [ - "h" - ], - "group": "Global Options", - "description": "Display help text", - "type": "boolean" - }, - { - "name": "help-web", - "aliases": [ - "hw" - ], - "group": "Global Options", - "description": "Display HTML help in browser", - "type": "boolean" - } - ], - "positionals": [] - }, { "name": "local-hook-token", "aliases": [ @@ -4882,14 +4525,6 @@ "defaultValue": "master", "group": "Options" }, - { - "name": "only-work-environment", - "description": "If specified, only elements from the Endevor work environment will be synchronized.", - "type": "boolean", - "required": false, - "group": "Options", - "aliases": [] - }, { "name": "read-only", "description": "If specified, it is necessary to use the option --endevor-stage-number. The synchronized elements will be read-only.", @@ -4920,9 +4555,32 @@ "group": "Options" }, { - "name": "type-filter", - "description": "Type filter", + "name": "type-filters", + "description": "Type filters that your mapping will be using. There can be multiple separated by a space. eg --type-filters \"COBOL\" \"COPY\".", + "type": "array", + "required": false, + "group": "Options", + "aliases": [] + }, + { + "name": "name-filters", + "description": "Name filters that your mapping will be using. There can be multiple separated by a space. eg --name-filters \"ELE*\" \"CO*\".", + "type": "array", + "required": false, + "group": "Options", + "aliases": [] + }, + { + "name": "repository-check", + "description": "If set to allowNonEmpty, user can proceed with initialization even if the repository is not empty.", + "allowableValues": { + "values": [ + "REQUIRE_EMPTY", + "ALLOW_NON_EMPTY" + ] + }, "type": "string", + "defaultValue": "REQUIRE_EMPTY", "required": false, "group": "Options", "aliases": [] @@ -4957,7 +4615,6 @@ "read-only", "endevor-instance", "endevor-environment", - "endevor-environment", "endevor-system", "endevor-subsystem" ], @@ -6842,8 +6499,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": true, - "group": "Required Options" + "required": false, + "group": "Options" }, { "name": "work-dir", @@ -7108,8 +6765,8 @@ ], "description": "The Endevor Web Services Endevor configuration name.", "type": "string", - "required": true, - "group": "Required Options" + "required": false, + "group": "Options" }, { "name": "work-dir",