Skip to content

Commit 287e07c

Browse files
docs(serverless_jobs): add documentation for command, timezone and schedule fields (#2044)
Co-authored-by: Mia-Cross <[email protected]>
1 parent 13a6959 commit 287e07c

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

api/jobs/v1alpha1/jobs_sdk.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,10 @@ func (enum *ListJobRunsRequestOrderBy) UnmarshalJSON(data []byte) error {
137137

138138
// CronSchedule: cron schedule.
139139
type CronSchedule struct {
140+
// Schedule: uNIX cron schedule to run job (e.g., '* * * * *').
140141
Schedule string `json:"schedule"`
141142

143+
// Timezone: timezone for the cron schedule, in tz database format (e.g., 'Europe/Paris').
142144
Timezone string `json:"timezone"`
143145
}
144146

@@ -247,7 +249,7 @@ type CreateJobDefinitionRequest struct {
247249
// ImageURI: image to use for the job.
248250
ImageURI string `json:"image_uri"`
249251

250-
// Command: startup command.
252+
// Command: startup command. If empty or not defined, the image's default command is used.
251253
Command string `json:"command"`
252254

253255
// ProjectID: UUID of the Scaleway Project containing the job.

0 commit comments

Comments
 (0)