Method patchTemplateMeta

coderd/templates.go:653–858

@Summary Update template settings by ID @ID update-template-settings-by-id @Security CoderSessionToken @Accept json @Produce json @Tags Templates @Param template path string true "Template ID" format(uuid) @Param request body codersdk.UpdateTemplateMeta true "Patch template settings request" @Succes

(rw http.ResponseWriter, r *http.Request)

// @Success 200 {object} codersdk.Template
// @Router /api/v2/templates/{template} [patch]
func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
	var (
		ctx               = r.Context()
		template          = httpmw.TemplateParam(r)
		auditor           = *api.Auditor.Load()
		portSharer        = *api.PortSharer.Load()
		aReq, commitAudit = audit.InitRequest[database.Template](rw, &audit.RequestParams{
			Audit:          auditor,
			Log:            api.Logger,
			Request:        r,
			Action:         database.AuditActionWrite,
			OrganizationID: template.OrganizationID,
		})
	)
	defer commitAudit()
	aReq.Old = template

	scheduleOpts, err := (*api.TemplateScheduleStore.Load()).Get(ctx, api.Database, template.ID)
	if err != nil {
		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
			Message: "Internal error fetching template schedule options.",
			Detail:  err.Error(),
		})
		return
	}

	var req codersdk.UpdateTemplateMeta
	if !httpapi.Read(ctx, rw, r, &req) {
		return
	}

	// resolveTemplateMetaUpdate falls back to the existing template's
	// values for any pointer field that is nil in the request, so that
	// omitted fields are preserved instead of being overwritten with
	// Go zero values.
	resolved, validErrs := resolveTemplateMetaUpdate(template, scheduleOpts, req)

	if resolved.defaultTTLMillis < 0 {
		validErrs = append(validErrs, codersdk.ValidationError{Field: "default_ttl_ms", Detail: "Must be a positive integer."})
	}
	if resolved.activityBumpMillis < 0 {
		validErrs = append(validErrs, codersdk.ValidationError{Field: "activity_bump_ms", Detail: "Must be a positive integer."})
	}
	if resolved.autostopRequirementWeeks > schedule.MaxTemplateAutostopRequirementWeeks {
		validErrs = append(validErrs, codersdk.ValidationError{Field: "autostop_requirement.weeks", Detail: fmt.Sprintf("Must be less than %d.", schedule.MaxTemplateAutostopRequirementWeeks)})
	}
	// AutostopRequirement.Weeks is allowed to be negative on input but is
	// surfaced as a validation error. resolveTemplateMetaUpdate normalizes
	// 0 -> 1 but preserves negatives so the caller can reject them.
	if req.AutostopRequirement != nil && req.AutostopRequirement.Weeks < 0 {
		validErrs = append(validErrs, codersdk.ValidationError{Field: "autostop_requirement.weeks", Detail: "Must be a positive integer."})
	}
	if template.AutostopRequirementWeeks <= 0 {
		template.AutostopRequirementWeeks = defaultRequirementWeeks
	}

	// The minimum valid value for a dormant TTL is 1 minute. This is
	// to ensure an uninformed user does not send an unintentionally