diff --git a/packages/cli/__tests__/zosjobs/__integration__/list/__snapshots__/cli.zos-jobs.list.jobs.integration.test.ts.snap b/packages/cli/__tests__/zosjobs/__integration__/list/__snapshots__/cli.zos-jobs.list.jobs.integration.test.ts.snap index fb1063eb05..c7d4abae27 100644 --- a/packages/cli/__tests__/zosjobs/__integration__/list/__snapshots__/cli.zos-jobs.list.jobs.integration.test.ts.snap +++ b/packages/cli/__tests__/zosjobs/__integration__/list/__snapshots__/cli.zos-jobs.list.jobs.integration.test.ts.snap @@ -195,8 +195,8 @@ exports[`zos-jobs list command should display the help 1`] = ` $ zowe zos-jobs list jobs -o \\"ibmu*\\" --exec-data - List all jobs owned by user IDs starting with 'ibmu' and - job names starting with 'myjo' and return job - execution data along with the default information: + job names starting with 'myjo' and return job execution data along with the + default information: $ zowe zos-jobs list jobs -o \\"ibmu*\\" -p \\"myjo*\\" --exec-data @@ -204,8 +204,8 @@ exports[`zos-jobs list command should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: jobs.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n jobs | js\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List jobs on JES spool/queues. By default, the command lists jobs owned (owner)\\\\n by the user specified in your z/OSMF profile. The default for prefix is \\\\\\"*\\\\\\". The\\\\n command does not prevalidate your user ID. The command surfaces errors verbatim\\\\n from the z/OSMF Jobs REST endpoints.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs list jobs [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --owner | -o (string)\\\\n\\\\n Specify the owner of the jobs you want to list. The owner is the individual/user\\\\n who submitted the job OR the user ID assigned to the job. The command does not\\\\n prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs\\\\n REST endpoint documentation, which is usually in the form \\\\\\"USER*\\\\\\".\\\\n\\\\n --prefix | -p (string)\\\\n\\\\n Specify the job name prefix of the jobs you want to list. The command does not\\\\n prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs\\\\n REST endpoint documentation, which is usually in the form \\\\\\"JOB*\\\\\\".\\\\n\\\\n --exec-data | --ed (boolean)\\\\n\\\\n Use this option to retrieve execution data for jobs via the z/OSMF REST API.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - List all jobs with default settings. The command returns\\\\n jobs owned by your user ID with any job name:\\\\n\\\\n $ zowe zos-jobs list jobs\\\\n\\\\n - List all jobs owned by user IDs starting with 'ibmu' and\\\\n job names starting with 'myjo':\\\\n\\\\n $ zowe zos-jobs list jobs -o \\\\\\"ibmu*\\\\\\" -p \\\\\\"myjo*\\\\\\"\\\\n\\\\n - List all jobs with default owner and prefix settings,\\\\n displaying only the job ID of each job:\\\\n\\\\n $ zowe zos-jobs list jobs --rff jobid --rft table\\\\n\\\\n - List all jobs and return job execution data along with the\\\\n default information:\\\\n\\\\n $ zowe zos-jobs list jobs --exec-data\\\\n\\\\n - List all jobs owned by user IDs starting with 'ibmu' and\\\\n return job execution data along with the default information:\\\\n\\\\n $ zowe zos-jobs list jobs -o \\\\\\"ibmu*\\\\\\" --exec-data\\\\n\\\\n - List all jobs owned by user IDs starting with 'ibmu' and\\\\n job names starting with 'myjo' and return job\\\\n execution data along with the default information:\\\\n\\\\n $ zowe zos-jobs list jobs -o \\\\\\"ibmu*\\\\\\" -p \\\\\\"myjo*\\\\\\" --exec-data\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n jobs | js\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List jobs on JES spool/queues. By default, the command lists jobs owned (owner)\\\\n by the user specified in your z/OSMF profile. The default for prefix is \\\\\\"*\\\\\\". The\\\\n command does not prevalidate your user ID. The command surfaces errors verbatim\\\\n from the z/OSMF Jobs REST endpoints.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs list jobs [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --owner | -o (string)\\\\n\\\\n Specify the owner of the jobs you want to list. The owner is the individual/user\\\\n who submitted the job OR the user ID assigned to the job. The command does not\\\\n prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs\\\\n REST endpoint documentation, which is usually in the form \\\\\\"USER*\\\\\\".\\\\n\\\\n --prefix | -p (string)\\\\n\\\\n Specify the job name prefix of the jobs you want to list. The command does not\\\\n prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs\\\\n REST endpoint documentation, which is usually in the form \\\\\\"JOB*\\\\\\".\\\\n\\\\n --exec-data | --ed (boolean)\\\\n\\\\n Use this option to retrieve execution data for jobs via the z/OSMF REST API.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - List all jobs with default settings. The command returns\\\\n jobs owned by your user ID with any job name:\\\\n\\\\n $ zowe zos-jobs list jobs\\\\n\\\\n - List all jobs owned by user IDs starting with 'ibmu' and\\\\n job names starting with 'myjo':\\\\n\\\\n $ zowe zos-jobs list jobs -o \\\\\\"ibmu*\\\\\\" -p \\\\\\"myjo*\\\\\\"\\\\n\\\\n - List all jobs with default owner and prefix settings,\\\\n displaying only the job ID of each job:\\\\n\\\\n $ zowe zos-jobs list jobs --rff jobid --rft table\\\\n\\\\n - List all jobs and return job execution data along with the\\\\n default information:\\\\n\\\\n $ zowe zos-jobs list jobs --exec-data\\\\n\\\\n - List all jobs owned by user IDs starting with 'ibmu' and\\\\n return job execution data along with the default information:\\\\n\\\\n $ zowe zos-jobs list jobs -o \\\\\\"ibmu*\\\\\\" --exec-data\\\\n\\\\n - List all jobs owned by user IDs starting with 'ibmu' and\\\\n job names starting with 'myjo' and return job execution data along with the\\\\n default information:\\\\n\\\\n $ zowe zos-jobs list jobs -o \\\\\\"ibmu*\\\\\\" -p \\\\\\"myjo*\\\\\\" --exec-data\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n jobs | js\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List jobs on JES spool/queues. By default, the command lists jobs owned (owner)\\\\n by the user specified in your z/OSMF profile. The default for prefix is \\\\\\"*\\\\\\". The\\\\n command does not prevalidate your user ID. The command surfaces errors verbatim\\\\n from the z/OSMF Jobs REST endpoints.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs list jobs [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --owner | -o (string)\\\\n\\\\n Specify the owner of the jobs you want to list. The owner is the individual/user\\\\n who submitted the job OR the user ID assigned to the job. The command does not\\\\n prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs\\\\n REST endpoint documentation, which is usually in the form \\\\\\"USER*\\\\\\".\\\\n\\\\n --prefix | -p (string)\\\\n\\\\n Specify the job name prefix of the jobs you want to list. The command does not\\\\n prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs\\\\n REST endpoint documentation, which is usually in the form \\\\\\"JOB*\\\\\\".\\\\n\\\\n --exec-data | --ed (boolean)\\\\n\\\\n Use this option to retrieve execution data for jobs via the z/OSMF REST API.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - List all jobs with default settings. The command returns\\\\n jobs owned by your user ID with any job name:\\\\n\\\\n $ zowe zos-jobs list jobs\\\\n\\\\n - List all jobs owned by user IDs starting with 'ibmu' and\\\\n job names starting with 'myjo':\\\\n\\\\n $ zowe zos-jobs list jobs -o \\\\\\"ibmu*\\\\\\" -p \\\\\\"myjo*\\\\\\"\\\\n\\\\n - List all jobs with default owner and prefix settings,\\\\n displaying only the job ID of each job:\\\\n\\\\n $ zowe zos-jobs list jobs --rff jobid --rft table\\\\n\\\\n - List all jobs and return job execution data along with the\\\\n default information:\\\\n\\\\n $ zowe zos-jobs list jobs --exec-data\\\\n\\\\n - List all jobs owned by user IDs starting with 'ibmu' and\\\\n return job execution data along with the default information:\\\\n\\\\n $ zowe zos-jobs list jobs -o \\\\\\"ibmu*\\\\\\" --exec-data\\\\n\\\\n - List all jobs owned by user IDs starting with 'ibmu' and\\\\n job names starting with 'myjo' and return job\\\\n execution data along with the default information:\\\\n\\\\n $ zowe zos-jobs list jobs -o \\\\\\"ibmu*\\\\\\" -p \\\\\\"myjo*\\\\\\" --exec-data\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n jobs | js\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List jobs on JES spool/queues. By default, the command lists jobs owned (owner)\\\\n by the user specified in your z/OSMF profile. The default for prefix is \\\\\\"*\\\\\\". The\\\\n command does not prevalidate your user ID. The command surfaces errors verbatim\\\\n from the z/OSMF Jobs REST endpoints.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs list jobs [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --owner | -o (string)\\\\n\\\\n Specify the owner of the jobs you want to list. The owner is the individual/user\\\\n who submitted the job OR the user ID assigned to the job. The command does not\\\\n prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs\\\\n REST endpoint documentation, which is usually in the form \\\\\\"USER*\\\\\\".\\\\n\\\\n --prefix | -p (string)\\\\n\\\\n Specify the job name prefix of the jobs you want to list. The command does not\\\\n prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs\\\\n REST endpoint documentation, which is usually in the form \\\\\\"JOB*\\\\\\".\\\\n\\\\n --exec-data | --ed (boolean)\\\\n\\\\n Use this option to retrieve execution data for jobs via the z/OSMF REST API.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - List all jobs with default settings. The command returns\\\\n jobs owned by your user ID with any job name:\\\\n\\\\n $ zowe zos-jobs list jobs\\\\n\\\\n - List all jobs owned by user IDs starting with 'ibmu' and\\\\n job names starting with 'myjo':\\\\n\\\\n $ zowe zos-jobs list jobs -o \\\\\\"ibmu*\\\\\\" -p \\\\\\"myjo*\\\\\\"\\\\n\\\\n - List all jobs with default owner and prefix settings,\\\\n displaying only the job ID of each job:\\\\n\\\\n $ zowe zos-jobs list jobs --rff jobid --rft table\\\\n\\\\n - List all jobs and return job execution data along with the\\\\n default information:\\\\n\\\\n $ zowe zos-jobs list jobs --exec-data\\\\n\\\\n - List all jobs owned by user IDs starting with 'ibmu' and\\\\n return job execution data along with the default information:\\\\n\\\\n $ zowe zos-jobs list jobs -o \\\\\\"ibmu*\\\\\\" --exec-data\\\\n\\\\n - List all jobs owned by user IDs starting with 'ibmu' and\\\\n job names starting with 'myjo' and return job execution data along with the\\\\n default information:\\\\n\\\\n $ zowe zos-jobs list jobs -o \\\\\\"ibmu*\\\\\\" -p \\\\\\"myjo*\\\\\\" --exec-data\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosjobs/__unit__/list/jobs/__snapshots__/Jobs.definition.unit.test.ts.snap b/packages/cli/__tests__/zosjobs/__unit__/list/jobs/__snapshots__/Jobs.definition.unit.test.ts.snap index 24653a7cdf..d97bfa33b7 100644 --- a/packages/cli/__tests__/zosjobs/__unit__/list/jobs/__snapshots__/Jobs.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosjobs/__unit__/list/jobs/__snapshots__/Jobs.definition.unit.test.ts.snap @@ -28,7 +28,7 @@ Object { "options": "-o \\"ibmu*\\" --exec-data", }, Object { - "description": "List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo' and return job execution data along with the default information", + "description": "List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo' and return job execution data along with the default information", "options": "-o \\"ibmu*\\" -p \\"myjo*\\" --exec-data", }, ], diff --git a/packages/cli/src/zosjobs/list/jobs/Jobs.definition.ts b/packages/cli/src/zosjobs/list/jobs/Jobs.definition.ts index db24abf7e8..99a6dd90dd 100644 --- a/packages/cli/src/zosjobs/list/jobs/Jobs.definition.ts +++ b/packages/cli/src/zosjobs/list/jobs/Jobs.definition.ts @@ -75,9 +75,9 @@ export const JobsDefinition: ICommandDefinition = { }, { options: "-o \"ibmu*\" -p \"myjo*\" --exec-data", - description: "List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo' and \ - return job execution data along with the default information" + description: "List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo' and " + + "return job execution data along with the default information" } ], outputFormatOptions: true -}; +}; \ No newline at end of file