Fix Device.UnmarshalJSON rejecting empty description string #218
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
…4.7 webhooks send device data with description as an empty string "" instead of null when the field is empty. The current validation logic incorrectly rejects empty strings as invalid values for required string fields. This fix removes the '|| value == ""' check from the UnmarshalJSON validation, as an empty string is a valid value for a string field and should only validate that the property exists in the JSON payload. Fixes unmarshaling of Device objects from NetBox 4.4.7 webhooks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
NetBox 4.4.7 webhooks send device data with
descriptionas an empty string""instead ofnullwhen the field is empty.The current validation logic in
UnmarshalJSONincorrectly rejects empty strings as invalid values for required string fields.This causes unmarshaling to fail with the error: no value given for required property description
Solution
Removed the
|| value == ""check from theUnmarshalJSONvalidation logic inmodel_device.go.An empty string is a valid value for a string field - the validation should only check that the property exists in the JSON payload, not whether it's an empty string.
Testing
Tested with NetBox 4.4.7 payloads containing
"description": ""- unmarshaling now succeeds.Notes
This same pattern (
|| value == "") exists in approximately 1200 other places across the model files. This PR fixes the specific issue I encountered with the Device model.