DXCDT-326: align --number usage across commands (#610)

Co-authored-by: Sergiu Ghitea <[email protected]>
Co-authored-by: Will Vedder <[email protected]>

CONTRIBUTING.md

@@ -9,7 +9,7 @@
 From the top-level directory:
 ```
 $ make build
-$ ./auth0 --help
+$ ./out/auth0 --help
 ```
 
 ## Adding a new command
@@ -41,7 +41,7 @@ We use vendoring, so the last step is required.
 
 > This is only possible if you're a repository maintainer.
 
-The release is driven by a Github **workflow** triggered when a new **tag** is **created**. The workflow will run the checks and trigger _Goreleaser_ to:
+The release is driven by a GitHub **workflow** triggered when a new **tag** is **created**. The workflow will run the checks and trigger _Goreleaser_ to:
 - create the Release with the proper description (changelog)
 - upload the binaries for the different architectures
 - update https://github.com/auth0/homebrew-auth0-cli with the latest binary reference

docs/auth0_apis_list.md

@@ -24,7 +24,7 @@ auth0 apis list [flags]
 
 ```
       --json         Output in json format.
-  -n, --number int   Number of apps to retrieve (default 50)
+  -n, --number int   Number of APIs to retrieve. Minimum 1, maximum 1000. (default 50)
 ```
 
 

docs/auth0_apps_list.md

@@ -25,7 +25,7 @@ auth0 apps list [flags]
 
 ```
       --json             Output in json format.
-  -n, --number int       Number of apps to retrieve (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.
 ```
 

docs/auth0_orgs_list.md

@@ -24,7 +24,7 @@ auth0 orgs list [flags]
 
 ```
       --json         Output in json format.
-  -n, --number int   Number of apps to retrieve (default 50)
+  -n, --number int   Number of organizations to retrieve. Minimum 1, maximum 1000. (default 50)
 ```
 
 

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 apps to retrieve (default 50)
+  -n, --number int   Number of organization members to retrieve. Minimum 1, maximum 1000. (default 50)
 ```
 
 

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 apps to retrieve (default 50)
+  -n, --number int   Number of organization roles to retrieve. Minimum 1, maximum 1000. (default 50)
 ```
 
 

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 apps to retrieve (default 50)
+  -n, --number int       Number of members to retrieve. Minimum 1, maximum 1000. (default 50)
   -r, --role-id string   Role Identifier.
 ```
 

docs/auth0_roles_list.md

@@ -24,7 +24,7 @@ auth0 roles list [flags]
 
 ```
       --json         Output in json format.
-  -n, --number int   Number of apps to retrieve (default 50)
+  -n, --number int   Number of roles to retrieve. Minimum 1, maximum 1000. (default 50)
 ```
 
 

docs/auth0_roles_permissions_list.md

@@ -15,14 +15,16 @@ auth0 roles permissions list [flags]
 ```
   auth0 roles permissions list
   auth0 roles permissions ls <role-id>
-  auth0 roles permissions ls <role-id> --json
+  auth0 roles permissions ls <role-id> --number 100
+  auth0 roles permissions ls <role-id> -n 100 --json
 ```
 
 
 ## Flags
 
 ```
-      --json   Output in json format.
+      --json         Output in json format.
+  -n, --number int   Number of permissions to retrieve. Minimum 1, maximum 1000. (default 50)
 ```
 
 

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, that match the search criteria, to retrieve. Minimum 1, maximum 1000. If limit is hit, refine the search query. (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'.
 ```

internal/ansi/ansi.go

@@ -48,7 +48,7 @@ func Color() aurora.Aurora {
 
 // Initialize re-instantiates the Aurora instance
 // This initialization step is necessary because the parsing of the
-// --no-color flag is done fairly late in the application cycle
+// --no-color flag is done fairly late in the application cycle.
 func Initialize(shouldDisableColors bool) {
 	DisableColors = shouldDisableColors
 	color = Color()

internal/cli/apis.go

@@ -54,6 +54,12 @@ var (
 		Help:         "Whether Refresh Tokens can be issued for this API (true) or not (false).",
 		AlwaysPrompt: true,
 	}
+	apiNumber = Flag{
+		Name:      "Number",
+		LongForm:  "number",
+		ShortForm: "n",
+		Help:      "Number of APIs to retrieve. Minimum 1, maximum 1000.",
+	}
 )
 
 func apisCmd(cli *cli) *cobra.Command {
@@ -107,6 +113,10 @@ func listApisCmd(cli *cli) *cobra.Command {
   auth0 apis ls --number 100
   auth0 apis ls -n 100 --json`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			if inputs.Number < 1 || inputs.Number > 1000 {
+				return fmt.Errorf("number flag invalid, please pass a number between 1 and 1000")
+			}
+
 			list, err := getWithPagination(
 				cmd.Context(),
 				inputs.Number,
@@ -139,7 +149,7 @@ func listApisCmd(cli *cli) *cobra.Command {
 	}
 
 	cmd.Flags().BoolVar(&cli.json, "json", false, "Output in json format.")
-	number.RegisterInt(cmd, &inputs.Number, defaultPageSize)
+	apiNumber.RegisterInt(cmd, &inputs.Number, defaultPageSize)
 
 	return cmd
 }

internal/cli/apps.go

@@ -119,11 +119,11 @@ var (
 		ShortForm: "r",
 		Help:      "Display the application secrets ('signing_keys', 'client_secret') as part of the command output.",
 	}
-	number = Flag{
+	appNumber = Flag{
 		Name:      "Number",
 		LongForm:  "number",
 		ShortForm: "n",
-		Help:      "Number of apps to retrieve",
+		Help:      "Number of apps to retrieve. Minimum 1, maximum 1000.",
 	}
 )
 
@@ -216,6 +216,10 @@ func listAppsCmd(cli *cli) *cobra.Command {
   auth0 apps list --reveal-secrets --number 100
   auth0 apps ls -r -n 100 --json`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			if inputs.Number < 1 || inputs.Number > 1000 {
+				return fmt.Errorf("number flag invalid, please pass a number between 1 and 1000")
+			}
+
 			list, err := getWithPagination(
 				cmd.Context(),
 				inputs.Number,
@@ -244,7 +248,7 @@ func listAppsCmd(cli *cli) *cobra.Command {
 
 	cmd.Flags().BoolVar(&cli.json, "json", false, "Output in json format.")
 	revealSecrets.RegisterBool(cmd, &inputs.RevealSecrets, false)
-	number.RegisterInt(cmd, &inputs.Number, defaultPageSize)
+	appNumber.RegisterInt(cmd, &inputs.Number, defaultPageSize)
 
 	return cmd
 }

internal/cli/organizations.go

@@ -77,6 +77,13 @@ var (
 		Help:       "Role Identifier.",
 		IsRequired: true,
 	}
+
+	// Purposefully not setting the Help value on the Flag because overridden where appropriate. 
+	organizationNumber = Flag{
+		Name:      "Number",
+		LongForm:  "number",
+		ShortForm: "n",
+	}
 )
 
 func organizationsCmd(cli *cli) *cobra.Command {
@@ -117,6 +124,10 @@ func listOrganizationsCmd(cli *cli) *cobra.Command {
   auth0 orgs ls --json
   auth0 orgs ls -n 100`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			if inputs.Number < 1 || inputs.Number > 1000 {
+				return fmt.Errorf("number flag invalid, please pass a number between 1 and 1000")
+			}
+
 			list, err := getWithPagination(
 				cmd.Context(),
 				inputs.Number,
@@ -149,7 +160,8 @@ func listOrganizationsCmd(cli *cli) *cobra.Command {
 	}
 
 	cmd.Flags().BoolVar(&cli.json, "json", false, "Output in json format.")
-	number.RegisterInt(cmd, &inputs.Number, defaultPageSize)
+	organizationNumber.Help = "Number of organizations to retrieve. Minimum 1, maximum 1000."
+	organizationNumber.RegisterInt(cmd, &inputs.Number, defaultPageSize)
 
 	return cmd
 }
@@ -507,6 +519,10 @@ func listMembersOrganizationCmd(cli *cli) *cobra.Command {
   auth0 orgs members list <org-id> --number 100
   auth0 orgs members ls <org-id> -n 100 --json`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			if inputs.Number < 1 || inputs.Number > 1000 {
+				return fmt.Errorf("number flag invalid, please pass a number between 1 and 1000")
+			}
+
 			if len(args) == 0 {
 				err := organizationID.Pick(cmd, &inputs.ID, cli.organizationPickerOptions)
 				if err != nil {
@@ -526,7 +542,8 @@ func listMembersOrganizationCmd(cli *cli) *cobra.Command {
 		},
 	}
 
-	number.RegisterInt(cmd, &inputs.Number, defaultPageSize)
+	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())
 
@@ -565,6 +582,9 @@ func listRolesOrganizationCmd(cli *cli) *cobra.Command {
   auth0 orgs roles list <org-id> --number 100
   auth0 orgs roles ls <org-id> -n 100 --json`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			if inputs.Number < 1 || inputs.Number > 1000 {
+				return fmt.Errorf("number flag invalid, please pass a number between 1 and 1000")
+			}
 			if len(args) == 0 {
 				err := organizationID.Pick(cmd, &inputs.OrgID, cli.organizationPickerOptions)
 				if err != nil {
@@ -588,7 +608,8 @@ func listRolesOrganizationCmd(cli *cli) *cobra.Command {
 		},
 	}
 
-	number.RegisterInt(cmd, &inputs.Number, defaultPageSize)
+	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.")
 
@@ -628,6 +649,10 @@ func listMembersRolesOrganizationCmd(cli *cli) *cobra.Command {
   auth0 orgs roles members ls <org-id> -r role -n 100
   auth0 orgs roles members ls <org-id> -r role -n 100 --json`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			if inputs.Number < 1 || inputs.Number > 1000 {
+				return fmt.Errorf("number flag invalid, please pass a number between 1 and 1000")
+			}
+
 			if len(args) == 0 {
 				err := organizationID.Pick(cmd, &inputs.OrgID, cli.organizationPickerOptions)
 				if err != nil {
@@ -661,7 +686,8 @@ 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, "")
-	number.RegisterInt(cmd, &inputs.Number, defaultPageSize)
+	organizationNumber.Help = "Number of members to retrieve. Minimum 1, maximum 1000."
+	organizationNumber.RegisterInt(cmd, &inputs.Number, defaultPageSize)
 
 	return cmd
 }

internal/cli/roles.go

@@ -29,6 +29,12 @@ var (
 		ShortForm: "d",
 		Help:      "Description of the role.",
 	}
+	roleNumber = Flag{
+		Name:      "Number",
+		LongForm:  "number",
+		ShortForm: "n",
+		Help:      "Number of roles to retrieve. Minimum 1, maximum 1000.",
+	}
 )
 
 func rolesCmd(cli *cli) *cobra.Command {
@@ -66,6 +72,10 @@ func listRolesCmd(cli *cli) *cobra.Command {
   auth0 roles ls --number 100
   auth0 roles ls -n 100 --json`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			if inputs.Number < 1 || inputs.Number > 1000 {
+				return fmt.Errorf("number flag invalid, please pass a number between 1 and 1000")
+			}
+
 			list, err := getWithPagination(
 				cmd.Context(),
 				inputs.Number,
@@ -98,7 +108,7 @@ func listRolesCmd(cli *cli) *cobra.Command {
 	}
 
 	cmd.Flags().BoolVar(&cli.json, "json", false, "Output in json format.")
-	number.RegisterInt(cmd, &inputs.Number, defaultPageSize)
+	roleNumber.RegisterInt(cmd, &inputs.Number, defaultPageSize)
 
 	return cmd
 }