feat: add examples to api

coder · f0ssel · Dec 9, 2022 · Dec 6, 2022 · Dec 7, 2022 · Dec 7, 2022
commit 300a763560cf37f80cf036e6c54cc9884e89eace
diff --git a/cli/templateinit.go b/cli/templateinit.go
@@ -8,6 +8,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/coder/coder/cli/cliui"
+	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/examples"
 	"github.com/coder/coder/provisionersdk"
 )
@@ -22,7 +23,7 @@ func templateInit() *cobra.Command {
 				return err
 			}
 			exampleNames := []string{}
-			exampleByName := map[string]examples.Example{}
+			exampleByName := map[string]codersdk.TemplateExample{}
 			for _, example := range exampleList {
 				name := fmt.Sprintf(
 					"%s\n%s\n%s\n",

diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -355,6 +355,7 @@ func New(options *Options) *API {
 					r.Post("/", api.postTemplateByOrganization)
 					r.Get("/", api.templatesByOrganization)
 					r.Get("/{templatename}", api.templateByOrganizationAndName)
+					r.Get("/examples", api.templateExamples)
 				})
 				r.Route("/members", func(r chi.Router) {
 					r.Get("/roles", api.assignableOrgRoles)

diff --git a/coderd/users.go b/coderd/users.go
@@ -825,6 +825,21 @@ func (api *API) putUserRoles(rw http.ResponseWriter, r *http.Request) {
 	httpapi.Write(ctx, rw, http.StatusOK, convertUser(updatedUser, organizationIDs))
 }
 
+func (_ *API) templateExamples(rw http.ResponseWriter, r *http.Request) {
+	ctx := r.Context()
+
+	ex, err := examples.List()
+	if err != nil {
+		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Internal error fetching examples.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	httpapi.Write(ctx, rw, http.StatusOK, ex)
+}
+
 // updateSiteUserRoles will ensure only site wide roles are passed in as arguments.
 // If an organization role is included, an error is returned.
 func (api *API) updateSiteUserRoles(ctx context.Context, args database.UpdateUserRolesParams) (database.User, error) {

diff --git a/codersdk/organizations.go b/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       uuid.UUID                `json:"example_id,omitempty" validate:"required_without=FileID"`
 	Provisioner     ProvisionerType          `json:"provisioner" validate:"oneof=terraform echo,required"`
 	ProvisionerTags map[string]string        `json:"tags"`
 

diff --git a/codersdk/templates.go b/codersdk/templates.go
@@ -82,6 +82,14 @@ 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"`
+	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)

diff --git a/examples/examples.go b/examples/examples.go
@@ -12,30 +12,24 @@ import (
 	"github.com/gohugoio/hugo/parser/pageparser"
 	"golang.org/x/sync/singleflight"
 	"golang.org/x/xerrors"
+
+	"github.com/coder/coder/codersdk"
 )
 
 var (
 	//go:embed templates
 	files embed.FS
 
 	exampleBasePath = "https://github.com/coder/coder/tree/main/examples/templates/"
-	examples        = make([]Example, 0)
+	examples        = make([]codersdk.TemplateExample, 0)
 	parseExamples   sync.Once
 	archives        = singleflight.Group{}
 )
 
-type Example struct {
-	ID          string `json:"id"`
-	URL         string `json:"url"`
-	Name        string `json:"name"`
-	Description string `json:"description"`
-	Markdown    string `json:"markdown"`
-}
-
 const rootDir = "templates"
 
 // List returns all embedded examples.
-func List() ([]Example, error) {
+func List() ([]codersdk.TemplateExample, error) {
 	var returnError error
 	parseExamples.Do(func() {
 		files, err := fs.Sub(files, rootDir)
@@ -92,7 +86,7 @@ func List() ([]Example, error) {
 				return
 			}
 
-			examples = append(examples, Example{
+			examples = append(examples, codersdk.TemplateExample{
 				ID:          exampleID,
 				URL:         exampleURL,
 				Name:        name,
@@ -112,7 +106,7 @@ func Archive(exampleID string) ([]byte, error) {
 			return nil, xerrors.Errorf("list: %w", err)
 		}
 
-		var selected Example
+		var selected codersdk.TemplateExample
 		for _, example := range examples {
 			if example.ID != exampleID {
 				continue

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -189,7 +189,8 @@ export interface CreateTemplateVersionRequest {
   readonly name?: string
   readonly template_id?: string
   readonly storage_method: ProvisionerStorageMethod
-  readonly file_id: string
+  readonly file_id?: string
+  readonly example_id?: string
   readonly provisioner: ProvisionerType
   readonly tags: Record<string, string>
   readonly parameter_values?: CreateParameterRequest[]
@@ -668,6 +669,15 @@ export interface TemplateDAUsResponse {
   readonly entries: DAUEntry[]
 }
 
+// From codersdk/templates.go
+export interface TemplateExample {
+  readonly id: string
+  readonly url: string
+  readonly name: string
+  readonly description: string
+  readonly markdown: string
+}
+
 // From codersdk/templates.go
 export interface TemplateGroup extends Group {
   readonly role: TemplateRole