docs(serverless_jobs): add documentation for command, timezone and sc…

…hedule fields (scaleway#3749) Co-authored-by: Mia-Cross <lmarabese@scaleway.com>
Laure-di · Apr 16, 2024 · d33ab52 · d33ab52
1 parent 855eb5c
commit d33ab52
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/cmd/scw/testdata/test-all-usage-jobs-definition-create-usage.golden b/cmd/scw/testdata/test-all-usage-jobs-definition-create-usage.golden
@@ -11,7 +11,7 @@ ARGS:
   memory-limit                    Memory limit of the job (in MiB)
   [local-storage-capacity]        Local storage capacity of the job (in MiB)
   [image-uri]                     Image to use for the job
-  [command]                       Startup command
+  [command]                       Startup command. If empty or not defined, the image's default command is used.
   [project-id]                    Project ID to use. If none is passed the default project ID will be used
   [environment-variables.{key}]   Environment variables of the job
   [description]                   Description of the job

diff --git a/docs/commands/jobs.md b/docs/commands/jobs.md
@@ -41,7 +41,7 @@ scw jobs definition create [arg=value ...]
 | memory-limit | Required | Memory limit of the job (in MiB) |
 | local-storage-capacity |  | Local storage capacity of the job (in MiB) |
 | image-uri |  | Image to use for the job |
-| command |  | Startup command |
+| command |  | Startup command. If empty or not defined, the image's default command is used. |
 | project-id |  | Project ID to use. If none is passed the default project ID will be used |
 | environment-variables.{key} |  | Environment variables of the job |
 | description |  | Description of the job |

diff --git a/internal/namespaces/jobs/v1alpha1/jobs_cli.go b/internal/namespaces/jobs/v1alpha1/jobs_cli.go
@@ -107,7 +107,7 @@ func jobsDefinitionCreate() *core.Command {
 			},
 			{
 				Name:       "command",
-				Short:      `Startup command`,
+				Short:      `Startup command. If empty or not defined, the image's default command is used.`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,