diff --git a/cmd/scw/testdata/test-all-usage-tem-domain-list-usage.golden b/cmd/scw/testdata/test-all-usage-tem-domain-list-usage.golden index 6d2fafa518..b50dcf3dfc 100644 --- a/cmd/scw/testdata/test-all-usage-tem-domain-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-tem-domain-list-usage.golden @@ -6,10 +6,10 @@ USAGE: scw tem domain list [arg=value ...] ARGS: - [project-id] - [status.{index}] (unknown | checked | unchecked | invalid | locked | revoked | pending) - [name] - [organization-id] + [project-id] (Optional) ID of the Project in which to list the domains + [status.{index}] (Optional) List domains under specific statuses (unknown | checked | unchecked | invalid | locked | revoked | pending) + [name] (Optional) Names of the domains to list + [organization-id] (Optional) ID of the Organization in which to list the domains [region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | all) FLAGS: diff --git a/docs/commands/tem.md b/docs/commands/tem.md index a366f3f74b..d2dd18e6a3 100644 --- a/docs/commands/tem.md +++ b/docs/commands/tem.md @@ -119,10 +119,10 @@ scw tem domain list [arg=value ...] | Name | | Description | |------|---|-------------| -| project-id | | | -| status.{index} | One of: `unknown`, `checked`, `unchecked`, `invalid`, `locked`, `revoked`, `pending` | | -| name | | | -| organization-id | | | +| project-id | | (Optional) ID of the Project in which to list the domains | +| status.{index} | One of: `unknown`, `checked`, `unchecked`, `invalid`, `locked`, `revoked`, `pending` | (Optional) List domains under specific statuses | +| name | | (Optional) Names of the domains to list | +| organization-id | | (Optional) ID of the Organization in which to list the domains | | region | Default: `fr-par`
One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config | diff --git a/internal/namespaces/tem/v1alpha1/tem_cli.go b/internal/namespaces/tem/v1alpha1/tem_cli.go index 0c5cc54991..a319304815 100644 --- a/internal/namespaces/tem/v1alpha1/tem_cli.go +++ b/internal/namespaces/tem/v1alpha1/tem_cli.go @@ -528,12 +528,14 @@ func temDomainList() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "project-id", + Short: `(Optional) ID of the Project in which to list the domains`, Required: false, Deprecated: false, Positional: false, }, { Name: "status.{index}", + Short: `(Optional) List domains under specific statuses`, Required: false, Deprecated: false, Positional: false, @@ -541,12 +543,14 @@ func temDomainList() *core.Command { }, { Name: "name", + Short: `(Optional) Names of the domains to list`, Required: false, Deprecated: false, Positional: false, }, { Name: "organization-id", + Short: `(Optional) ID of the Organization in which to list the domains`, Required: false, Deprecated: false, Positional: false,