Skip to content

chore: correct template API docs #19228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+301 −11
Open

chore: correct template API docs #19228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d21f8cf
chore: correct template API docs
phorcys420 Aug 7, 2025
2bcd765
chore: make gen
phorcys420 Aug 7, 2025
350ab71
Update coderd/templates.go
phorcys420 Aug 7, 2025
ee08def
chore: rerun make gen
phorcys420 Aug 7, 2025
856d4b5
Merge branch 'main' into phorcys420/fix-template-api-docs
phorcys420 Aug 7, 2025
c49c60c
Merge branch 'main' into phorcys420/fix-template-api-docs
phorcys420 Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 94 additions & 2 deletions coderd/apidoc/docs.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

96 changes: 94 additions & 2 deletions coderd/apidoc/swagger.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions coderd/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import (

// Returns a single template.
//
// @Summary Get template metadata by ID
// @Summary Get template settings by ID
// @ID get-template-metadata-by-id
// @Security CoderSessionToken
// @Produce json
Expand Down Expand Up @@ -629,12 +629,13 @@ func (api *API) templateByOrganizationAndName(rw http.ResponseWriter, r *http.Re
httpapi.Write(ctx, rw, http.StatusOK, api.convertTemplate(template))
}

// @Summary Update template metadata by ID
// @Summary Update template settings by ID
// @ID update-template-metadata-by-id
// @Security CoderSessionToken
// @Produce json
// @Tags Templates
// @Param template path string true "Template ID" format(uuid)
// @Param request body codersdk.UpdateTemplateMeta true "Patch template settings request"
// @Success 200 {object} codersdk.Template
// @Router /templates/{template} [patch]
func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
Expand Down
Loading
Loading