fix!: support empty or default fields when updating templates #19256
+178
−74
Conversation
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
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
cdrci2
added a commit
to coder/cla
that referenced
this pull request
Aug 8, 2025
Emyrk
reviewed
Aug 8, 2025
|
Can we add a This is a breaking change for the |
Emyrk
approved these changes
Aug 12, 2025
There was a problem hiding this comment.
LG 👍
Just throw the ! in the commit title, fix!:. Add to the description the breaking change is the field types in codersdk.UpdateTemplateMeta for icon, description, and displayname moved to *string
Interestingly, the typescript types are unchanged because omitempty was included. So the typscript was already correct ❤️
readonly display_name?: string;
readonly description?: string;
readonly icon?: string;
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Breaking change: Field types in
codersdk.UpdateTemplateMetaforIcon,Description, andDisplayNamemoved to*stringSummary
In this pull request we're updating the
UpdateTemplateMetastruct to allowDisplayName,Description, andIconto be set as empty""or default to the value from the template if not provided in an update call.Fixes #19036
The bug
The reported bug occurred when clients were attempting to update a metadata field in a template via an edit call. When the request was decoded into an
UpdateTemplateMetastruct the default values for fields in the struct were used to update the template even if they weren't provided. This led to fields likeIconbeing set to""(the default value).Changes
To allow for specific fields to be set to
""these fields were updated to be*stringas opposed tostring. This allows for clients to set these fields as""in an update request or they will default to the template value if they are not provided in the update request (will benil).Added tests to confirm empty and nil values and updated other tests that use these fields.