feat(coder): Add PATCH /templateversions/:templateversion endpoint

BrunoQuaresma · BrunoQuaresma · commit f5bf8f9965b7 · 2023-03-21T17:11:56.000Z
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dbauthz/querier.go b/coderd/database/dbauthz/querier.go
@@ -850,13 +850,13 @@ func (q *querier) UpdateTemplateScheduleByID(ctx context.Context, arg database.U
 	return updateWithReturn(q.log, q.auth, fetch, q.db.UpdateTemplateScheduleByID)(ctx, arg)
 }
 
-func (q *querier) UpdateTemplateVersionByID(ctx context.Context, arg database.UpdateTemplateVersionByIDParams) error {
+func (q *querier) UpdateTemplateVersionByID(ctx context.Context, arg database.UpdateTemplateVersionByIDParams) (database.TemplateVersion, error) {
 	template, err := q.db.GetTemplateByID(ctx, arg.TemplateID.UUID)
 	if err != nil {
-		return err
+		return database.TemplateVersion{}, err
 	}
 	if err := q.authorizeContext(ctx, rbac.ActionUpdate, template); err != nil {
-		return err
+		return database.TemplateVersion{}, err
 	}
 	return q.db.UpdateTemplateVersionByID(ctx, arg)
 }
diff --git a/coderd/database/dbfake/databasefake.go b/coderd/database/dbfake/databasefake.go
@@ -3413,9 +3413,9 @@ func (q *fakeQuerier) UpdateTemplateACLByID(_ context.Context, arg database.Upda
 	return database.Template{}, sql.ErrNoRows
 }
 
-func (q *fakeQuerier) UpdateTemplateVersionByID(_ context.Context, arg database.UpdateTemplateVersionByIDParams) error {
+func (q *fakeQuerier) UpdateTemplateVersionByID(_ context.Context, arg database.UpdateTemplateVersionByIDParams) (database.TemplateVersion, error) {
 	if err := validateDatabaseType(arg); err != nil {
-		return err
+		return database.TemplateVersion{}, err
 	}
 
 	q.mutex.Lock()
@@ -3427,10 +3427,11 @@ func (q *fakeQuerier) UpdateTemplateVersionByID(_ context.Context, arg database.
 		}
 		templateVersion.TemplateID = arg.TemplateID
 		templateVersion.UpdatedAt = arg.UpdatedAt
+		templateVersion.Name = arg.Name
 		q.templateVersions[index] = templateVersion
-		return nil
+		return templateVersion, nil
 	}
-	return sql.ErrNoRows
+	return database.TemplateVersion{}, sql.ErrNoRows
 }
 
 func (q *fakeQuerier) UpdateTemplateVersionDescriptionByJobID(_ context.Context, arg database.UpdateTemplateVersionDescriptionByJobIDParams) error {
diff --git a/coderd/database/querier.go b/coderd/database/querier.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/templateversions.sql b/coderd/database/queries/templateversions.sql
@@ -84,14 +84,15 @@ INSERT INTO
 VALUES
 	($1, $2, $3, $4, $5, $6, $7, $8, $9) RETURNING *;
 
--- name: UpdateTemplateVersionByID :exec
+-- name: UpdateTemplateVersionByID :one
 UPDATE
 	template_versions
 SET
 	template_id = $2,
-	updated_at = $3
+	updated_at = $3,
+	name = $4
 WHERE
-	id = $1;
+	id = $1 RETURNING *;
 
 -- name: UpdateTemplateVersionDescriptionByJobID :exec
 UPDATE
diff --git a/coderd/templates.go b/coderd/templates.go
@@ -269,7 +269,7 @@ func (api *API) postTemplateByOrganization(rw http.ResponseWriter, r *http.Reque
 
 		templateAudit.New = dbTemplate
 
-		err = tx.UpdateTemplateVersionByID(ctx, database.UpdateTemplateVersionByIDParams{
+		_, err = tx.UpdateTemplateVersionByID(ctx, database.UpdateTemplateVersionByIDParams{
 			ID: templateVersion.ID,
 			TemplateID: uuid.NullUUID{
 				UUID:  dbTemplate.ID,
diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -63,6 +63,35 @@ func (api *API) templateVersion(rw http.ResponseWriter, r *http.Request) {
 	httpapi.Write(ctx, rw, http.StatusOK, convertTemplateVersion(templateVersion, convertProvisionerJob(job), user))
 }
 
+// @Summary Patch template version by ID
+// @ID patch-template-version-by-id
+// @Security CoderSessionToken
+// @Produce json
+// @Tags Templates
+// @Param templateversion path string true "Template version ID" format(uuid)
+// @Success 200 {object} codersdk.TemplateVersion
+// @Router /templateversions/{templateversion} [patch]
+func (api *API) patchTemplateVersion(rw http.ResponseWriter, r *http.Request) {
+	ctx := r.Context()
+	templateVersion := httpmw.TemplateVersionParam(r)
+	var params codersdk.PatchTemplateVersionRequest
+	if !httpapi.Read(ctx, rw, r, &params) {
+		return
+	}
+	templateVersion, err := api.Database.UpdateTemplateVersionByID(ctx, database.UpdateTemplateVersionByIDParams{
+		ID:   templateVersion.ID,
+		Name: params.Name,
+	})
+	if err != nil {
+		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Error on patching template version.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+	httpapi.Write(ctx, rw, http.StatusNoContent, templateVersion)
+}
+
 // @Summary Cancel template version by ID
 // @ID cancel-template-version-by-id
 // @Security CoderSessionToken
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -199,7 +199,7 @@ func ParseSSHConfigOption(opt string) (key string, value string, err error) {
 		return r == ' ' || r == '='
 	})
 	if idx == -1 {
-		return "", "", fmt.Errorf("invalid config-ssh option %q", opt)
+		return "", "", xerrors.New(fmt.Sprintf("invalid config-ssh option %q", opt))
 	}
 	return opt[:idx], opt[idx+1:], nil
 }
diff --git a/codersdk/templateversions.go b/codersdk/templateversions.go
@@ -76,6 +76,10 @@ type TemplateVersionVariable struct {
 	Sensitive    bool   `json:"sensitive"`
 }
 
+type PatchTemplateVersionRequest struct {
+	Name string `json:"name"`
+}
+
 // 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)
@@ -291,3 +295,15 @@ func (c *Client) PreviousTemplateVersion(ctx context.Context, organization uuid.
 	var version TemplateVersion
 	return version, json.NewDecoder(res.Body).Decode(&version)
 }
+
+func (c *Client) UpdateTemplateVersion(ctx context.Context, version, req PatchTemplateVersionRequest) error {
+	res, err := c.Request(ctx, http.MethodPatch, fmt.Sprintf("/api/v2/templateversions/%s", version), req)
+	if err != nil {
+		return err
+	}
+	defer res.Body.Close()
+	if res.StatusCode != http.StatusNoContent {
+		return ReadBodyAsError(res)
+	}
+	return nil
+}
diff --git a/docs/api/templates.md b/docs/api/templates.md
@@ -1250,6 +1250,81 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion} \
 
 To perform this operation, you must be authenticated. [Learn more](authentication.md).
 
+## Patch template version by ID
+
+### Code samples
+
+```shell
+# Example request using curl
+curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion} \
+  -H 'Accept: application/json' \
+  -H 'Coder-Session-Token: API_KEY'
+```
+
+`PATCH /templateversions/{templateversion}`
+
+### Parameters
+
+| Name              | In   | Type         | Required | Description         |
+| ----------------- | ---- | ------------ | -------- | ------------------- |
+| `templateversion` | path | string(uuid) | true     | Template version ID |
+
+### Example responses
+
+> 200 Response
+
+```json
+{
+  "created_at": "2019-08-24T14:15:22Z",
+  "created_by": {
+    "avatar_url": "http://example.com",
+    "created_at": "2019-08-24T14:15:22Z",
+    "email": "user@example.com",
+    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
+    "last_seen_at": "2019-08-24T14:15:22Z",
+    "organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
+    "roles": [
+      {
+        "display_name": "string",
+        "name": "string"
+      }
+    ],
+    "status": "active",
+    "username": "string"
+  },
+  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
+  "job": {
+    "canceled_at": "2019-08-24T14:15:22Z",
+    "completed_at": "2019-08-24T14:15:22Z",
+    "created_at": "2019-08-24T14:15:22Z",
+    "error": "string",
+    "error_code": "MISSING_TEMPLATE_PARAMETER",
+    "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
+    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
+    "started_at": "2019-08-24T14:15:22Z",
+    "status": "pending",
+    "tags": {
+      "property1": "string",
+      "property2": "string"
+    },
+    "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
+  },
+  "name": "string",
+  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
+  "readme": "string",
+  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
+  "updated_at": "2019-08-24T14:15:22Z"
+}
+```
+
+### Responses
+
+| Status | Meaning                                                 | Description | Schema                                                         |
+| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------- |
+| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) |
+
+To perform this operation, you must be authenticated. [Learn more](authentication.md).
+
 ## Cancel template version by ID
 
 ### Code samples
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -577,6 +577,11 @@ export interface PatchGroupRequest {
   readonly quota_allowance?: number
 }
 
+// From codersdk/templateversions.go
+export interface PatchTemplateVersionRequest {
+  readonly name: string
+}
+
 // From codersdk/deployment.go
 export interface PprofConfig {
   readonly enable: boolean

Original file line number	Diff line number	Diff line change
`@@ -850,13 +850,13 @@ func (q *querier) UpdateTemplateScheduleByID(ctx context.Context, arg database.U`
`850`	`850`	`return updateWithReturn(q.log, q.auth, fetch, q.db.UpdateTemplateScheduleByID)(ctx, arg)`
`851`	`851`	`}`
`852`	`852`
`853`		`-func (q *querier) UpdateTemplateVersionByID(ctx context.Context, arg database.UpdateTemplateVersionByIDParams) error {`
	`853`	`+func (q *querier) UpdateTemplateVersionByID(ctx context.Context, arg database.UpdateTemplateVersionByIDParams) (database.TemplateVersion, error) {`
`854`	`854`	`template, err := q.db.GetTemplateByID(ctx, arg.TemplateID.UUID)`
`855`	`855`	`if err != nil {`
`856`		`- return err`
	`856`	`+ return database.TemplateVersion{}, err`
`857`	`857`	`}`
`858`	`858`	`if err := q.authorizeContext(ctx, rbac.ActionUpdate, template); err != nil {`
`859`		`- return err`
	`859`	`+ return database.TemplateVersion{}, err`
`860`	`860`	`}`
`861`	`861`	`return q.db.UpdateTemplateVersionByID(ctx, arg)`
`862`	`862`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3413,9 +3413,9 @@ func (q *fakeQuerier) UpdateTemplateACLByID(_ context.Context, arg database.Upda`
`3413`	`3413`	`return database.Template{}, sql.ErrNoRows`
`3414`	`3414`	`}`
`3415`	`3415`
`3416`		`-func (q *fakeQuerier) UpdateTemplateVersionByID(_ context.Context, arg database.UpdateTemplateVersionByIDParams) error {`
	`3416`	`+func (q *fakeQuerier) UpdateTemplateVersionByID(_ context.Context, arg database.UpdateTemplateVersionByIDParams) (database.TemplateVersion, error) {`
`3417`	`3417`	`if err := validateDatabaseType(arg); err != nil {`
`3418`		`- return err`
	`3418`	`+ return database.TemplateVersion{}, err`
`3419`	`3419`	`}`
`3420`	`3420`
`3421`	`3421`	`q.mutex.Lock()`
`@@ -3427,10 +3427,11 @@ func (q *fakeQuerier) UpdateTemplateVersionByID(_ context.Context, arg database.`
`3427`	`3427`	`}`
`3428`	`3428`	`templateVersion.TemplateID = arg.TemplateID`
`3429`	`3429`	`templateVersion.UpdatedAt = arg.UpdatedAt`
	`3430`	`+ templateVersion.Name = arg.Name`
`3430`	`3431`	`q.templateVersions[index] = templateVersion`
`3431`		`- return nil`
	`3432`	`+ return templateVersion, nil`
`3432`	`3433`	`}`
`3433`		`- return sql.ErrNoRows`
	`3434`	`+ return database.TemplateVersion{}, sql.ErrNoRows`
`3434`	`3435`	`}`
`3435`	`3436`
`3436`	`3437`	`func (q *fakeQuerier) UpdateTemplateVersionDescriptionByJobID(_ context.Context, arg database.UpdateTemplateVersionDescriptionByJobIDParams) error {`
Original file line number	Diff line number	Diff line change
`@@ -199,7 +199,7 @@ func ParseSSHConfigOption(opt string) (key string, value string, err error) {`
`199`	`199`	`return r == ' ' \|\| r == '='`
`200`	`200`	`})`
`201`	`201`	`if idx == -1 {`
`202`		`- return "", "", fmt.Errorf("invalid config-ssh option %q", opt)`
	`202`	`+ return "", "", xerrors.New(fmt.Sprintf("invalid config-ssh option %q", opt))`
`203`	`203`	`}`
`204`	`204`	`return opt[:idx], opt[idx+1:], nil`
`205`	`205`	`}`