Skip to content

Commit

Permalink
docs(serverless_jobs): add documentation for command, timezone and sc…
Browse files Browse the repository at this point in the history
…hedule fields (scaleway#2044)

Co-authored-by: Mia-Cross <[email protected]>
  • Loading branch information
scaleway-bot and Mia-Cross authored Apr 4, 2024
1 parent 13a6959 commit 287e07c
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion api/jobs/v1alpha1/jobs_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,10 @@ func (enum *ListJobRunsRequestOrderBy) UnmarshalJSON(data []byte) error {

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

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

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

// Command: startup command.
// Command: startup command. If empty or not defined, the image's default command is used.
Command string `json:"command"`

// ProjectID: UUID of the Scaleway Project containing the job.
Expand Down

0 comments on commit 287e07c

Please sign in to comment.