fix: codersdk: add documentation for UpdateWorkspaceAutostartRequest / UpdateWorkspaceAutostart

johnstcn · johnstcn · commit 3b4664cc8e8b · 2022-04-06T20:05:21.000Z
diff --git a/codersdk/workspaces.go b/codersdk/workspaces.go
@@ -90,10 +90,13 @@ func (c *Client) WorkspaceBuildByName(ctx context.Context, workspace uuid.UUID,
 	return workspaceBuild, json.NewDecoder(res.Body).Decode(&workspaceBuild)
 }
 
+// UpdateWorkspaceAutostartRequest is a request to update a workspace's autostart schedule.
 type UpdateWorkspaceAutostartRequest struct {
 	Schedule string
 }
 
+// UpdateWorkspaceAutostart sets the autostart schedule for workspace by id.
+// If the provided schedule is empty, autostart is disabled for the workspace.
 func (c *Client) UpdateWorkspaceAutostart(ctx context.Context, id uuid.UUID, req UpdateWorkspaceAutostartRequest) error {
 	path := fmt.Sprintf("/api/v2/workspaces/%s/autostart", id.String())
 	res, err := c.request(ctx, http.MethodPut, path, req)

Original file line number	Diff line number	Diff line change
`@@ -90,10 +90,13 @@ func (c *Client) WorkspaceBuildByName(ctx context.Context, workspace uuid.UUID,`
`90`	`90`	`return workspaceBuild, json.NewDecoder(res.Body).Decode(&workspaceBuild)`
`91`	`91`	`}`
`92`	`92`
	`93`	`+// UpdateWorkspaceAutostartRequest is a request to update a workspace's autostart schedule.`
`93`	`94`	`type UpdateWorkspaceAutostartRequest struct {`
`94`	`95`	`Schedule string`
`95`	`96`	`}`
`96`	`97`
	`98`	`+// UpdateWorkspaceAutostart sets the autostart schedule for workspace by id.`
	`99`	`+// If the provided schedule is empty, autostart is disabled for the workspace.`
`97`	`100`	`func (c *Client) UpdateWorkspaceAutostart(ctx context.Context, id uuid.UUID, req UpdateWorkspaceAutostartRequest) error {`
`98`	`101`	`path := fmt.Sprintf("/api/v2/workspaces/%s/autostart", id.String())`
`99`	`102`	`res, err := c.request(ctx, http.MethodPut, path, req)`