Skip to content

Commit d704ff4

Browse files
johnstcnjohnstcn
authored
chore(codersdk): explain format of codersdk.UpdateWorkspaceAutostartRequest.Schedule (coder#12539)
1 parent a546cb8 commit d704ff4

File tree

4 files changed

+8
-3
lines changed

4 files changed

+8
-3
lines changed

‎coderd/apidoc/docs.go

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/apidoc/swagger.json

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎codersdk/workspaces.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,9 @@ func (c *Client) UpdateWorkspace(ctx context.Context, id uuid.UUID, req UpdateWo
253253

254254
// UpdateWorkspaceAutostartRequest is a request to update a workspace's autostart schedule.
255255
type UpdateWorkspaceAutostartRequest struct {
256+
// Schedule is expected to be of the form `CRON_TZ=<IANA Timezone> <min> <hour> * * <dow>`
257+
// Example: `CRON_TZ=US/Central 30 9 * * 1-5` represents 0930 in the timezone US/Central
258+
// on weekdays (Mon-Fri). `CRON_TZ` defaults to UTC if not present.
256259
Schedule *string `json:"schedule"`
257260
}
258261

‎docs/api/schemas.md

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)