Skip to content

Commit 70de603

Browse files
authored
docs(serverless_jobs): add documentation for command, timezone and schedule fields (#1217)
1 parent 0df2792 commit 70de603

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

packages/clients/src/api/jobs/v1alpha1/types.gen.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,12 @@ export type ListJobDefinitionsRequestOrderBy =
1919
export type ListJobRunsRequestOrderBy = 'created_at_asc' | 'created_at_desc'
2020

2121
export interface CronSchedule {
22+
/** UNIX cron schedule to run job (e.g., '* * * * *'). */
2223
schedule: string
24+
/**
25+
* Timezone for the cron schedule, in tz database format (e.g.,
26+
* 'Europe/Paris').
27+
*/
2328
timezone: string
2429
}
2530

@@ -94,7 +99,10 @@ export type CreateJobDefinitionRequest = {
9499
localStorageCapacity?: number
95100
/** Image to use for the job. */
96101
imageUri: string
97-
/** Startup command. */
102+
/**
103+
* Startup command. If empty or not defined, the image's default command is
104+
* used.
105+
*/
98106
command: string
99107
/** UUID of the Scaleway Project containing the job. */
100108
projectId?: string

0 commit comments

Comments
 (0)