feat: add examples to api (#5331)

Co-authored-by: Dean Sheather <dean@deansheather.com>

codersdk/organizations.go

@@ -38,7 +38,8 @@ type CreateTemplateVersionRequest struct {
 	// TemplateID optionally associates a version with a template.
 	TemplateID      uuid.UUID                `json:"template_id,omitempty"`
 	StorageMethod   ProvisionerStorageMethod `json:"storage_method" validate:"oneof=file,required"`
-	FileID          uuid.UUID                `json:"file_id" validate:"required"`
+	FileID          uuid.UUID                `json:"file_id,omitempty" validate:"required_without=ExampleID"`
+	ExampleID       string                   `json:"example_id,omitempty" validate:"required_without=FileID"`
 	Provisioner     ProvisionerType          `json:"provisioner" validate:"oneof=terraform echo,required"`
 	ProvisionerTags map[string]string        `json:"tags"`
 

codersdk/templates.go

@@ -82,6 +82,16 @@ type UpdateTemplateMeta struct {
 	AllowUserCancelWorkspaceJobs bool   `json:"allow_user_cancel_workspace_jobs,omitempty"`
 }
 
+type TemplateExample struct {
+	ID          string   `json:"id"`
+	URL         string   `json:"url"`
+	Name        string   `json:"name"`
+	Description string   `json:"description"`
+	Icon        string   `json:"icon"`
+	Tags        []string `json:"tags"`
+	Markdown    string   `json:"markdown"`
+}
+
 // Template returns a single template.
 func (c *Client) Template(ctx context.Context, template uuid.UUID) (Template, error) {
 	res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templates/%s", template), nil)
@@ -238,3 +248,17 @@ type AgentStatsReportResponse struct {
 	// TxBytes is the number of transmitted bytes.
 	TxBytes int64 `json:"tx_bytes"`
 }
+
+// TemplateExamples lists example templates embedded in coder.
+func (c *Client) TemplateExamples(ctx context.Context, organizationID uuid.UUID) ([]TemplateExample, error) {
+	res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/organizations/%s/templates/examples", organizationID), nil)
+	if err != nil {
+		return nil, err
+	}
+	defer res.Body.Close()
+	if res.StatusCode != http.StatusOK {
+		return nil, readBodyAsError(res)
+	}
+	var templateExamples []TemplateExample
+	return templateExamples, json.NewDecoder(res.Body).Decode(&templateExamples)
+}