From d8c07f88597419f779b354ed158439265d41613a Mon Sep 17 00:00:00 2001 From: Ewan Harris Date: Tue, 17 Jan 2023 14:58:33 +0000 Subject: [PATCH] Rework help text for number flag --- docs/auth0_apis_list.md | 2 +- docs/auth0_apps_list.md | 2 +- docs/auth0_orgs_list.md | 2 +- docs/auth0_orgs_members_list.md | 2 +- docs/auth0_orgs_roles_list.md | 2 +- docs/auth0_orgs_roles_members_list.md | 2 +- docs/auth0_roles_list.md | 2 +- docs/auth0_roles_permissions_list.md | 2 +- docs/auth0_users_search.md | 2 +- internal/cli/apis.go | 2 +- internal/cli/apps.go | 2 +- internal/cli/organizations.go | 8 ++++---- internal/cli/roles.go | 2 +- internal/cli/roles_permissions.go | 2 +- internal/cli/users.go | 2 +- 15 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/auth0_apis_list.md b/docs/auth0_apis_list.md index a3de16fdd..aedec1fe4 100644 --- a/docs/auth0_apis_list.md +++ b/docs/auth0_apis_list.md @@ -24,7 +24,7 @@ auth0 apis list [flags] ``` --json Output in json format. - -n, --number int Number of APIs, that match the search criteria, to retrieve. Maximum result number is 1000. (default 50) + -n, --number int Number of APIs to retrieve. Minimum 1, maximum 1000. (default 50) ``` diff --git a/docs/auth0_apps_list.md b/docs/auth0_apps_list.md index c86e004ca..e8bacaa6d 100644 --- a/docs/auth0_apps_list.md +++ b/docs/auth0_apps_list.md @@ -25,7 +25,7 @@ auth0 apps list [flags] ``` --json Output in json format. - -n, --number int Number of apps, that match the search criteria, to retrieve. Maximum result number is 1000. (default 50) + -n, --number int Number of apps to retrieve. Minimum 1, maximum 1000. (default 50) -r, --reveal-secrets Display the application secrets ('signing_keys', 'client_secret') as part of the command output. ``` diff --git a/docs/auth0_orgs_list.md b/docs/auth0_orgs_list.md index c8bbb0c95..62ddf1c94 100644 --- a/docs/auth0_orgs_list.md +++ b/docs/auth0_orgs_list.md @@ -24,7 +24,7 @@ auth0 orgs list [flags] ``` --json Output in json format. - -n, --number int Number of organizations, that match the search criteria, to retrieve. Maximum result number is 1000. (default 50) + -n, --number int Number of organizations to retrieve. Minimum 1, maximum 1000. (default 50) ``` diff --git a/docs/auth0_orgs_members_list.md b/docs/auth0_orgs_members_list.md index b77a78db2..a179c625e 100644 --- a/docs/auth0_orgs_members_list.md +++ b/docs/auth0_orgs_members_list.md @@ -24,7 +24,7 @@ auth0 orgs members list [flags] ``` --json Output in json format. - -n, --number int Number of organization members to retrieve. Maximum result number is 1000. (default 50) + -n, --number int Number of organization members to retrieve. Minimum 1, maximum 1000. (default 50) ``` diff --git a/docs/auth0_orgs_roles_list.md b/docs/auth0_orgs_roles_list.md index 28773ae94..f4eced8c9 100644 --- a/docs/auth0_orgs_roles_list.md +++ b/docs/auth0_orgs_roles_list.md @@ -24,7 +24,7 @@ auth0 orgs roles list [flags] ``` --json Output in json format. - -n, --number int Number of organization roles to retrieve. Maximum result number is 1000. (default 50) + -n, --number int Number of organization roles to retrieve. Minimum 1, maximum 1000. (default 50) ``` diff --git a/docs/auth0_orgs_roles_members_list.md b/docs/auth0_orgs_roles_members_list.md index 8edb9e4bc..3293f414e 100644 --- a/docs/auth0_orgs_roles_members_list.md +++ b/docs/auth0_orgs_roles_members_list.md @@ -26,7 +26,7 @@ auth0 orgs roles members list [flags] ``` --json Output in json format. - -n, --number int Number of member to retrieve. Maximum result number is 1000. (default 50) + -n, --number int Number of members to retrieve. Minimum 1, maximum 1000. (default 50) -r, --role-id string Role Identifier. ``` diff --git a/docs/auth0_roles_list.md b/docs/auth0_roles_list.md index 4fcade6e6..fd85db8d7 100644 --- a/docs/auth0_roles_list.md +++ b/docs/auth0_roles_list.md @@ -24,7 +24,7 @@ auth0 roles list [flags] ``` --json Output in json format. - -n, --number int Number of roles, that match the search criteria, to retrieve. Maximum result number is 1000. (default 50) + -n, --number int Number of roles to retrieve. Minimum 1, maximum 1000. (default 50) ``` diff --git a/docs/auth0_roles_permissions_list.md b/docs/auth0_roles_permissions_list.md index 7de14993f..e7c1ada00 100644 --- a/docs/auth0_roles_permissions_list.md +++ b/docs/auth0_roles_permissions_list.md @@ -24,7 +24,7 @@ auth0 roles permissions list [flags] ``` --json Output in json format. - -n, --number int Number of permissions, that match the search criteria, to retrieve. Maximum result number is 1000. (default 50) + -n, --number int Number of permissions to retrieve. Minimum 1, maximum 1000. (default 50) ``` diff --git a/docs/auth0_users_search.md b/docs/auth0_users_search.md index 5e2db2ba9..feecd2a76 100644 --- a/docs/auth0_users_search.md +++ b/docs/auth0_users_search.md @@ -25,7 +25,7 @@ auth0 users search [flags] ``` --json Output in json format. - -n, --number int Number of users, that match the search criteria, to retrieve. Maximum result number is 1000. If limit is hit, please refine the search query. (default 50) + -n, --number int Number of users to retrieve. Minimum 1, maximum 1000. (default 50) -q, --query string Query in Lucene query syntax. See https://auth0.com/docs/users/user-search/user-search-query-syntax for more details. -s, --sort string Field to sort by. Use 'field:order' where 'order' is '1' for ascending and '-1' for descending. e.g. 'created_at:1'. ``` diff --git a/internal/cli/apis.go b/internal/cli/apis.go index 0924f7727..82303e5ad 100644 --- a/internal/cli/apis.go +++ b/internal/cli/apis.go @@ -58,7 +58,7 @@ var ( Name: "Number", LongForm: "number", ShortForm: "n", - Help: "Number of APIs, that match the search criteria, to retrieve. Maximum result number is 1000.", + Help: "Number of APIs to retrieve. Minimum 1, maximum 1000.", } ) diff --git a/internal/cli/apps.go b/internal/cli/apps.go index e9fe02527..dbb114854 100644 --- a/internal/cli/apps.go +++ b/internal/cli/apps.go @@ -123,7 +123,7 @@ var ( Name: "Number", LongForm: "number", ShortForm: "n", - Help: "Number of apps, that match the search criteria, to retrieve. Maximum result number is 1000.", + Help: "Number of apps to retrieve. Minimum 1, maximum 1000.", } ) diff --git a/internal/cli/organizations.go b/internal/cli/organizations.go index 3704fb788..636162b1e 100644 --- a/internal/cli/organizations.go +++ b/internal/cli/organizations.go @@ -160,7 +160,7 @@ func listOrganizationsCmd(cli *cli) *cobra.Command { } cmd.Flags().BoolVar(&cli.json, "json", false, "Output in json format.") - organizationNumber.Help = "Number of organizations, that match the search criteria, to retrieve. Maximum result number is 1000." + organizationNumber.Help = "Number of organizations to retrieve. Minimum 1, maximum 1000." organizationNumber.RegisterInt(cmd, &inputs.Number, defaultPageSize) return cmd @@ -542,7 +542,7 @@ func listMembersOrganizationCmd(cli *cli) *cobra.Command { }, } - organizationNumber.Help = "Number of organization members to retrieve. Maximum result number is 1000." + organizationNumber.Help = "Number of organization members to retrieve. Minimum 1, maximum 1000." organizationNumber.RegisterInt(cmd, &inputs.Number, defaultPageSize) cmd.Flags().BoolVar(&cli.json, "json", false, "Output in json format.") cmd.SetUsageTemplate(resourceUsageTemplate()) @@ -608,7 +608,7 @@ func listRolesOrganizationCmd(cli *cli) *cobra.Command { }, } - organizationNumber.Help = "Number of organization roles to retrieve. Maximum result number is 1000." + organizationNumber.Help = "Number of organization roles to retrieve. Minimum 1, maximum 1000." organizationNumber.RegisterInt(cmd, &inputs.Number, defaultPageSize) cmd.Flags().BoolVar(&cli.json, "json", false, "Output in json format.") @@ -686,7 +686,7 @@ func listMembersRolesOrganizationCmd(cli *cli) *cobra.Command { cmd.SetUsageTemplate(resourceUsageTemplate()) cmd.Flags().BoolVar(&cli.json, "json", false, "Output in json format.") roleIdentifier.RegisterString(cmd, &inputs.RoleID, "") - organizationNumber.Help = "Number of members to retrieve. Maximum result number is 1000." + organizationNumber.Help = "Number of members to retrieve. Minimum 1, maximum 1000." organizationNumber.RegisterInt(cmd, &inputs.Number, defaultPageSize) return cmd diff --git a/internal/cli/roles.go b/internal/cli/roles.go index 3e87a3ee1..ef784993b 100644 --- a/internal/cli/roles.go +++ b/internal/cli/roles.go @@ -33,7 +33,7 @@ var ( Name: "Number", LongForm: "number", ShortForm: "n", - Help: "Number of roles, that match the search criteria, to retrieve. Maximum result number is 1000.", + Help: "Number of roles to retrieve. Minimum 1, maximum 1000.", } ) diff --git a/internal/cli/roles_permissions.go b/internal/cli/roles_permissions.go index 8a42e9d55..5dd603f13 100644 --- a/internal/cli/roles_permissions.go +++ b/internal/cli/roles_permissions.go @@ -31,7 +31,7 @@ var ( Name: "Number", LongForm: "number", ShortForm: "n", - Help: "Number of permissions, that match the search criteria, to retrieve. Maximum result number is 1000.", + Help: "Number of permissions to retrieve. Minimum 1, maximum 1000.", } ) diff --git a/internal/cli/users.go b/internal/cli/users.go index 4b72a569d..ecb05e8dd 100644 --- a/internal/cli/users.go +++ b/internal/cli/users.go @@ -72,7 +72,7 @@ var ( Name: "Number", LongForm: "number", ShortForm: "n", - Help: "Number of users, that match the search criteria, to retrieve. Maximum result number is 1000. If limit is hit, please refine the search query.", + Help: "Number of users to retrieve. Minimum 1, maximum 1000.", } userImportTemplate = Flag{ Name: "Template",