Skip to content

Commit

Permalink
Updating job search help and snapshot
Browse files Browse the repository at this point in the history 
Signed-off-by: KevinLoesch1 <[email protected]>
  • Loading branch information
@KevinLoesch1
KevinLoesch1 committed Feb 9, 2024
1 parent 07d625b commit 322238b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
12 changes: 6 additions & 6 deletions ...obs/__integration__/search/__snapshots__/cli.zos-jobs.search.job.integration.test.ts.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,21 @@ exports[`zos-jobs search job command should display the help 1`] = `
--search-string | --string (string)
The string to search for in the spool output
The string to search for in the spool output.
--search-regex | --regex (string)
The regular expression to search for in the spool output
The regular expression to search for in the spool output.
--case-insensitive | --ci (boolean)
The search is case insensitive or not
The search is case insensitive or not.
Default value: true
--search-limit | --sl (number)
The maximum number of matching lines to return for an individual spool file
The maximum number of matching lines to return for an individual spool file.
Default value: 100
Expand Down Expand Up @@ -165,9 +165,9 @@ exports[`zos-jobs search job command should display the help 1`] = `
\\"success\\": true,
\\"exitCode\\": 0,
\\"message\\": \\"The help was constructed for command: job.\\",
\\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n job\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Search the spool output of a job.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs search job <jobname> [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n jobname\\\\t\\\\t (string)\\\\n\\\\n The job name to search. Wildcards are accepted for the job name. You can use,\\\\n for example \\\\\\"USERJOB*\\\\\\" to search all jobs that start with USERJOB.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --search-string | --string (string)\\\\n\\\\n The string to search for in the spool output\\\\n\\\\n --search-regex | --regex (string)\\\\n\\\\n The regular expression to search for in the spool output\\\\n\\\\n --case-insensitive | --ci (boolean)\\\\n\\\\n The search is case insensitive or not\\\\n\\\\n Default value: true\\\\n\\\\n --search-limit | --sl (number)\\\\n\\\\n The maximum number of matching lines to return for an individual spool file\\\\n\\\\n Default value: 100\\\\n\\\\n --file-limit | --fl (number)\\\\n\\\\n The maximum number of spool files to search.\\\\n\\\\n Default value: 100\\\\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 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 - Search all jobs named USERJOB for the string \\\\\\"RC=0000\\\\\\":\\\\n\\\\n $ zowe zos-jobs search job \\\\\\"USERJOB\\\\\\" --search-string \\\\\\"RC=0000\\\\\\"\\\\n\\\\n - Search all jobs that start with USER for the string\\\\n \\\\\\"ENDED\\\\\\":\\\\n\\\\n $ zowe zos-jobs search job \\\\\\"USER*\\\\\\" --search-string \\\\\\"ENDED\\\\\\"\\\\n\\\\n - Search all jobs named USERJOB for the string \\\\\\"COND CODE\\\\\\",\\\\n with the options case sensitive and a search limit of 5:\\\\n\\\\n $ zowe zos-jobs search job \\\\\\"USERJOB\\\\\\" --search-string \\\\\\"COND CODE\\\\\\" --case-insensitive false --search-limit 5\\\\n\\\\n\\",
\\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n job\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Search the spool output of a job.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs search job <jobname> [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n jobname\\\\t\\\\t (string)\\\\n\\\\n The job name to search. Wildcards are accepted for the job name. You can use,\\\\n for example \\\\\\"USERJOB*\\\\\\" to search all jobs that start with USERJOB.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --search-string | --string (string)\\\\n\\\\n The string to search for in the spool output.\\\\n\\\\n --search-regex | --regex (string)\\\\n\\\\n The regular expression to search for in the spool output.\\\\n\\\\n --case-insensitive | --ci (boolean)\\\\n\\\\n The search is case insensitive or not.\\\\n\\\\n Default value: true\\\\n\\\\n --search-limit | --sl (number)\\\\n\\\\n The maximum number of matching lines to return for an individual spool file.\\\\n\\\\n Default value: 100\\\\n\\\\n --file-limit | --fl (number)\\\\n\\\\n The maximum number of spool files to search.\\\\n\\\\n Default value: 100\\\\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 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 - Search all jobs named USERJOB for the string \\\\\\"RC=0000\\\\\\":\\\\n\\\\n $ zowe zos-jobs search job \\\\\\"USERJOB\\\\\\" --search-string \\\\\\"RC=0000\\\\\\"\\\\n\\\\n - Search all jobs that start with USER for the string\\\\n \\\\\\"ENDED\\\\\\":\\\\n\\\\n $ zowe zos-jobs search job \\\\\\"USER*\\\\\\" --search-string \\\\\\"ENDED\\\\\\"\\\\n\\\\n - Search all jobs named USERJOB for the string \\\\\\"COND CODE\\\\\\",\\\\n with the options case sensitive and a search limit of 5:\\\\n\\\\n $ zowe zos-jobs search job \\\\\\"USERJOB\\\\\\" --search-string \\\\\\"COND CODE\\\\\\" --case-insensitive false --search-limit 5\\\\n\\\\n\\",
\\"stderr\\": \\"\\",
\\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n job\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Search the spool output of a job.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs search job <jobname> [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n jobname\\\\t\\\\t (string)\\\\n\\\\n The job name to search. Wildcards are accepted for the job name. You can use,\\\\n for example \\\\\\"USERJOB*\\\\\\" to search all jobs that start with USERJOB.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --search-string | --string (string)\\\\n\\\\n The string to search for in the spool output\\\\n\\\\n --search-regex | --regex (string)\\\\n\\\\n The regular expression to search for in the spool output\\\\n\\\\n --case-insensitive | --ci (boolean)\\\\n\\\\n The search is case insensitive or not\\\\n\\\\n Default value: true\\\\n\\\\n --search-limit | --sl (number)\\\\n\\\\n The maximum number of matching lines to return for an individual spool file\\\\n\\\\n Default value: 100\\\\n\\\\n --file-limit | --fl (number)\\\\n\\\\n The maximum number of spool files to search.\\\\n\\\\n Default value: 100\\\\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 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 - Search all jobs named USERJOB for the string \\\\\\"RC=0000\\\\\\":\\\\n\\\\n $ zowe zos-jobs search job \\\\\\"USERJOB\\\\\\" --search-string \\\\\\"RC=0000\\\\\\"\\\\n\\\\n - Search all jobs that start with USER for the string\\\\n \\\\\\"ENDED\\\\\\":\\\\n\\\\n $ zowe zos-jobs search job \\\\\\"USER*\\\\\\" --search-string \\\\\\"ENDED\\\\\\"\\\\n\\\\n - Search all jobs named USERJOB for the string \\\\\\"COND CODE\\\\\\",\\\\n with the options case sensitive and a search limit of 5:\\\\n\\\\n $ zowe zos-jobs search job \\\\\\"USERJOB\\\\\\" --search-string \\\\\\"COND CODE\\\\\\" --case-insensitive false --search-limit 5\\\\n\\\\n\\"
\\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n job\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Search the spool output of a job.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs search job <jobname> [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n jobname\\\\t\\\\t (string)\\\\n\\\\n The job name to search. Wildcards are accepted for the job name. You can use,\\\\n for example \\\\\\"USERJOB*\\\\\\" to search all jobs that start with USERJOB.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --search-string | --string (string)\\\\n\\\\n The string to search for in the spool output.\\\\n\\\\n --search-regex | --regex (string)\\\\n\\\\n The regular expression to search for in the spool output.\\\\n\\\\n --case-insensitive | --ci (boolean)\\\\n\\\\n The search is case insensitive or not.\\\\n\\\\n Default value: true\\\\n\\\\n --search-limit | --sl (number)\\\\n\\\\n The maximum number of matching lines to return for an individual spool file.\\\\n\\\\n Default value: 100\\\\n\\\\n --file-limit | --fl (number)\\\\n\\\\n The maximum number of spool files to search.\\\\n\\\\n Default value: 100\\\\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 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 - Search all jobs named USERJOB for the string \\\\\\"RC=0000\\\\\\":\\\\n\\\\n $ zowe zos-jobs search job \\\\\\"USERJOB\\\\\\" --search-string \\\\\\"RC=0000\\\\\\"\\\\n\\\\n - Search all jobs that start with USER for the string\\\\n \\\\\\"ENDED\\\\\\":\\\\n\\\\n $ zowe zos-jobs search job \\\\\\"USER*\\\\\\" --search-string \\\\\\"ENDED\\\\\\"\\\\n\\\\n - Search all jobs named USERJOB for the string \\\\\\"COND CODE\\\\\\",\\\\n with the options case sensitive and a search limit of 5:\\\\n\\\\n $ zowe zos-jobs search job \\\\\\"USERJOB\\\\\\" --search-string \\\\\\"COND CODE\\\\\\" --case-insensitive false --search-limit 5\\\\n\\\\n\\"
}"
`;
Expand Down
8 changes: 4 additions & 4 deletions packages/cli/src/zosjobs/-strings-/en.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,10 @@ export default {
" with USERJOB."
},
OPTIONS: {
SEARCHSTRING: "The string to search for in the spool output",
SEARCHREGEX: "The regular expression to search for in the spool output",
CASEINSENSITIVE: "The search is case insensitive or not",
SEARCHLIMIT: "The maximum number of matching lines to return for an individual spool file",
SEARCHSTRING: "The string to search for in the spool output.",
SEARCHREGEX: "The regular expression to search for in the spool output.",
CASEINSENSITIVE: "The search is case insensitive or not.",
SEARCHLIMIT: "The maximum number of matching lines to return for an individual spool file.",
FILELIMIT: "The maximum number of spool files to search."
},
EXAMPLES: {
Expand Down

0 comments on commit 322238b

Please sign in to comment.