Skip to content

Commit

Permalink
Rework help text for number flag
Browse files Browse the repository at this point in the history
  • Loading branch information
ewanharris committed Jan 17, 2023
1 parent 3b09f4c commit d8c07f8
Show file tree
Hide file tree
Showing 15 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/auth0_apis_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```


Expand Down
2 changes: 1 addition & 1 deletion docs/auth0_apps_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```

Expand Down
2 changes: 1 addition & 1 deletion docs/auth0_orgs_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```


Expand Down
2 changes: 1 addition & 1 deletion docs/auth0_orgs_members_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```


Expand Down
2 changes: 1 addition & 1 deletion docs/auth0_orgs_roles_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```


Expand Down
2 changes: 1 addition & 1 deletion docs/auth0_orgs_roles_members_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```

Expand Down
2 changes: 1 addition & 1 deletion docs/auth0_roles_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```


Expand Down
2 changes: 1 addition & 1 deletion docs/auth0_roles_permissions_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```


Expand Down
2 changes: 1 addition & 1 deletion docs/auth0_users_search.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'.
```
Expand Down
2 changes: 1 addition & 1 deletion internal/cli/apis.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
}
)

Expand Down
2 changes: 1 addition & 1 deletion internal/cli/apps.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
}
)

Expand Down
8 changes: 4 additions & 4 deletions internal/cli/organizations.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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())
Expand Down Expand Up @@ -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.")
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion internal/cli/roles.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
}
)

Expand Down
2 changes: 1 addition & 1 deletion internal/cli/roles_permissions.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
}
)

Expand Down
2 changes: 1 addition & 1 deletion internal/cli/users.go
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit d8c07f8

Please sign in to comment.