Skip to content

Commit d21f8cf

Browse files
authored
chore: correct template API docs
1 parent 2851d9f commit d21f8cf

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

coderd/templates.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,13 @@ import (
3838

3939
// Returns a single template.
4040
//
41-
// @Summary Get template metadata by ID
41+
// @Summary Get template settings by ID
4242
// @ID get-template-metadata-by-id
4343
// @Security CoderSessionToken
4444
// @Produce json
4545
// @Tags Templates
4646
// @Param template path string true "Template ID" format(uuid)
47+
4748
// @Success 200 {object} codersdk.Template
4849
// @Router /templates/{template} [get]
4950
func (api *API) template(rw http.ResponseWriter, r *http.Request) {
@@ -629,12 +630,13 @@ func (api *API) templateByOrganizationAndName(rw http.ResponseWriter, r *http.Re
629630
httpapi.Write(ctx, rw, http.StatusOK, api.convertTemplate(template))
630631
}
631632

632-
// @Summary Update template metadata by ID
633+
// @Summary Update template settings by ID
633634
// @ID update-template-metadata-by-id
634635
// @Security CoderSessionToken
635636
// @Produce json
636637
// @Tags Templates
637638
// @Param template path string true "Template ID" format(uuid)
639+
// @Param request body codersdk.UpdateTemplateMeta true "Patch template settings request"
638640
// @Success 200 {object} codersdk.Template
639641
// @Router /templates/{template} [patch]
640642
func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy