package codersdk import ( "context" "encoding/json" "fmt" "io" "net/http" "time" "github.com/google/uuid" ) type TemplateVersionWarning string const ( TemplateVersionWarningUnsupportedWorkspaces TemplateVersionWarning = "UNSUPPORTED_WORKSPACES" ) // TemplateVersion represents a single version of a template. type TemplateVersion struct { ID uuid.UUID `json:"id" format:"uuid"` TemplateID *uuid.UUID `json:"template_id,omitempty" format:"uuid"` OrganizationID uuid.UUID `json:"organization_id,omitempty" format:"uuid"` CreatedAt time.Time `json:"created_at" format:"date-time"` UpdatedAt time.Time `json:"updated_at" format:"date-time"` Name string `json:"name"` Message string `json:"message"` Job ProvisionerJob `json:"job"` Readme string `json:"readme"` CreatedBy MinimalUser `json:"created_by"` Archived bool `json:"archived"` Warnings []TemplateVersionWarning `json:"warnings,omitempty" enums:"DEPRECATED_PARAMETERS"` } type TemplateVersionExternalAuth struct { ID string `json:"id"` Type string `json:"type"` DisplayName string `json:"display_name"` DisplayIcon string `json:"display_icon"` AuthenticateURL string `json:"authenticate_url"` Authenticated bool `json:"authenticated"` Optional bool `json:"optional,omitempty"` } type ValidationMonotonicOrder string const ( MonotonicOrderIncreasing ValidationMonotonicOrder = "increasing" MonotonicOrderDecreasing ValidationMonotonicOrder = "decreasing" ) // TemplateVersionParameter represents a parameter for a template version. type TemplateVersionParameter struct { Name string `json:"name"` DisplayName string `json:"display_name,omitempty"` Description string `json:"description"` DescriptionPlaintext string `json:"description_plaintext"` Type string `json:"type" enums:"string,number,bool,list(string)"` Mutable bool `json:"mutable"` DefaultValue string `json:"default_value"` Icon string `json:"icon"` Options []TemplateVersionParameterOption `json:"options"` ValidationError string `json:"validation_error,omitempty"` ValidationRegex string `json:"validation_regex,omitempty"` ValidationMin *int32 `json:"validation_min,omitempty"` ValidationMax *int32 `json:"validation_max,omitempty"` ValidationMonotonic ValidationMonotonicOrder `json:"validation_monotonic,omitempty" enums:"increasing,decreasing"` Required bool `json:"required"` Ephemeral bool `json:"ephemeral"` } // TemplateVersionParameterOption represents a selectable option for a template parameter. type TemplateVersionParameterOption struct { Name string `json:"name"` Description string `json:"description"` Value string `json:"value"` Icon string `json:"icon"` } // TemplateVersionVariable represents a managed template variable. type TemplateVersionVariable struct { Name string `json:"name"` Description string `json:"description"` Type string `json:"type" enums:"string,number,bool"` Value string `json:"value"` DefaultValue string `json:"default_value"` Required bool `json:"required"` Sensitive bool `json:"sensitive"` } type PatchTemplateVersionRequest struct { Name string `json:"name" validate:"omitempty,template_version_name"` Message *string `json:"message,omitempty" validate:"omitempty,lt=1048577"` } // TemplateVersion returns a template version by ID. func (c *Client) TemplateVersion(ctx context.Context, id uuid.UUID) (TemplateVersion, error) { res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s", id), nil) if err != nil { return TemplateVersion{}, err } defer res.Body.Close() if res.StatusCode != http.StatusOK { return TemplateVersion{}, ReadBodyAsError(res) } var version TemplateVersion return version, json.NewDecoder(res.Body).Decode(&version) } // CancelTemplateVersion marks a template version job as canceled. func (c *Client) CancelTemplateVersion(ctx context.Context, version uuid.UUID) error { res, err := c.Request(ctx, http.MethodPatch, fmt.Sprintf("/api/v2/templateversions/%s/cancel", version), nil) if err != nil { return err } defer res.Body.Close() if res.StatusCode != http.StatusOK { return ReadBodyAsError(res) } return nil } // TemplateVersionParameters returns parameters a template version exposes. func (c *Client) TemplateVersionRichParameters(ctx context.Context, version uuid.UUID) ([]TemplateVersionParameter, error) { res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/rich-parameters", version), nil) if err != nil { return nil, err } defer res.Body.Close() if res.StatusCode != http.StatusOK { return nil, ReadBodyAsError(res) } var params []TemplateVersionParameter return params, json.NewDecoder(res.Body).Decode(¶ms) } // TemplateVersionExternalAuth returns authentication providers for the requested template version. func (c *Client) TemplateVersionExternalAuth(ctx context.Context, version uuid.UUID) ([]TemplateVersionExternalAuth, error) { res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/external-auth", version), nil) if err != nil { return nil, err } defer res.Body.Close() if res.StatusCode != http.StatusOK { return nil, ReadBodyAsError(res) } var extAuth []TemplateVersionExternalAuth return extAuth, json.NewDecoder(res.Body).Decode(&extAuth) } // TemplateVersionResources returns resources a template version declares. func (c *Client) TemplateVersionResources(ctx context.Context, version uuid.UUID) ([]WorkspaceResource, error) { res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/resources", version), nil) if err != nil { return nil, err } defer res.Body.Close() if res.StatusCode != http.StatusOK { return nil, ReadBodyAsError(res) } var resources []WorkspaceResource return resources, json.NewDecoder(res.Body).Decode(&resources) } // TemplateVersionVariables returns resources a template version variables. func (c *Client) TemplateVersionVariables(ctx context.Context, version uuid.UUID) ([]TemplateVersionVariable, error) { res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/variables", version), nil) if err != nil { return nil, err } defer res.Body.Close() if res.StatusCode != http.StatusOK { return nil, ReadBodyAsError(res) } var variables []TemplateVersionVariable return variables, json.NewDecoder(res.Body).Decode(&variables) } // TemplateVersionLogsAfter streams logs for a template version that occurred after a specific log ID. func (c *Client) TemplateVersionLogsAfter(ctx context.Context, version uuid.UUID, after int64) (<-chan ProvisionerJobLog, io.Closer, error) { return c.provisionerJobLogsAfter(ctx, fmt.Sprintf("/api/v2/templateversions/%s/logs", version), after) } // CreateTemplateVersionDryRunRequest defines the request parameters for // CreateTemplateVersionDryRun. type CreateTemplateVersionDryRunRequest struct { WorkspaceName string `json:"workspace_name"` RichParameterValues []WorkspaceBuildParameter `json:"rich_parameter_values"` UserVariableValues []VariableValue `json:"user_variable_values,omitempty"` } // CreateTemplateVersionDryRun begins a dry-run provisioner job against the // given template version with the given parameter values. func (c *Client) CreateTemplateVersionDryRun(ctx context.Context, version uuid.UUID, req CreateTemplateVersionDryRunRequest) (ProvisionerJob, error) { res, err := c.Request(ctx, http.MethodPost, fmt.Sprintf("/api/v2/templateversions/%s/dry-run", version), req) if err != nil { return ProvisionerJob{}, err } defer res.Body.Close() if res.StatusCode != http.StatusCreated { return ProvisionerJob{}, ReadBodyAsError(res) } var job ProvisionerJob return job, json.NewDecoder(res.Body).Decode(&job) } // TemplateVersionDryRun returns the current state of a template version dry-run // job. func (c *Client) TemplateVersionDryRun(ctx context.Context, version, job uuid.UUID) (ProvisionerJob, error) { res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/dry-run/%s", version, job), nil) if err != nil { return ProvisionerJob{}, err } defer res.Body.Close() if res.StatusCode != http.StatusOK { return ProvisionerJob{}, ReadBodyAsError(res) } var j ProvisionerJob return j, json.NewDecoder(res.Body).Decode(&j) } // TemplateVersionDryRunResources returns the resources of a finished template // version dry-run job. func (c *Client) TemplateVersionDryRunResources(ctx context.Context, version, job uuid.UUID) ([]WorkspaceResource, error) { res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/dry-run/%s/resources", version, job), nil) if err != nil { return nil, err } defer res.Body.Close() if res.StatusCode != http.StatusOK { return nil, ReadBodyAsError(res) } var resources []WorkspaceResource return resources, json.NewDecoder(res.Body).Decode(&resources) } // TemplateVersionDryRunLogsAfter streams logs for a template version dry-run // that occurred after a specific log ID. func (c *Client) TemplateVersionDryRunLogsAfter(ctx context.Context, version, job uuid.UUID, after int64) (<-chan ProvisionerJobLog, io.Closer, error) { return c.provisionerJobLogsAfter(ctx, fmt.Sprintf("/api/v2/templateversions/%s/dry-run/%s/logs", version, job), after) } // CancelTemplateVersionDryRun marks a template version dry-run job as canceled. func (c *Client) CancelTemplateVersionDryRun(ctx context.Context, version, job uuid.UUID) error { res, err := c.Request(ctx, http.MethodPatch, fmt.Sprintf("/api/v2/templateversions/%s/dry-run/%s/cancel", version, job), nil) if err != nil { return err } defer res.Body.Close() if res.StatusCode != http.StatusOK { return ReadBodyAsError(res) } return nil } func (c *Client) PreviousTemplateVersion(ctx context.Context, organization uuid.UUID, templateName, versionName string) (TemplateVersion, error) { res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/organizations/%s/templates/%s/versions/%s/previous", organization, templateName, versionName), nil) if err != nil { return TemplateVersion{}, err } defer res.Body.Close() if res.StatusCode != http.StatusOK { return TemplateVersion{}, ReadBodyAsError(res) } var version TemplateVersion return version, json.NewDecoder(res.Body).Decode(&version) } func (c *Client) UpdateTemplateVersion(ctx context.Context, versionID uuid.UUID, req PatchTemplateVersionRequest) (TemplateVersion, error) { res, err := c.Request(ctx, http.MethodPatch, fmt.Sprintf("/api/v2/templateversions/%s", versionID), req) if err != nil { return TemplateVersion{}, err } defer res.Body.Close() if res.StatusCode != http.StatusOK { return TemplateVersion{}, ReadBodyAsError(res) } var version TemplateVersion return version, json.NewDecoder(res.Body).Decode(&version) }