chore: correct template API docs#19228
Merged
Merged
Conversation
Member
Author
|
Checked through the Swagger Editor by using "Load URL" with https://raw.githubusercontent.com/coder/coder/refs/heads/phorcys420/fix-template-api-docs/coderd/apidoc/swagger.json and it seems to be okay 
|
deansheather
reviewed
Aug 7, 2025
Co-authored-by: Dean Sheather <dean@deansheather.com>
deansheather
approved these changes
Aug 7, 2025
Member
deansheather
left a comment
There was a problem hiding this comment.
Looks good from a sound-ness perspective. I think Atif or Ben should sign off on the route name change, though
Member
Author
|
fyi Atif/Ben, I have renamed the "template metadata" wording to "template settings" in API docs as that is the wording we use in the UI, and one of my customers was confused about this, we just want your opinion on this. |
matifali
approved these changes
Aug 8, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
codersdk.UpdateTemplateMetatype, because it seemed like the most appropriate type fromcodersdk/templates.go, I made that decision based on howpatchOrganizationinenterprise/coderd/organizations.gocoder/enterprise/coderd/organizations.go
Line 28 in 2851d9f
codersdk.UpdateOrganizationRequestbodyrequired in the docs even though it isn't actually enforced (i.e an empty body works on that endpoint), I don't know if we should enforce it