fix: pass empty Locations and PrivateLocations to backend [sc-23129] #125
Conversation
This file contains 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
When omitempty, the property is not sent to the server. Our PUT endpoints however act like PATCH would, meaning that partial updates are supported. When a property is not set, it is kept intact, even though the intention most likely was to remove it.
sorccu
requested review from
maxigimenez,
pilimartinez,
Antoine-C and
shiini2
as code owners
Antoine-C
previously approved these changes
Jan 31, 2025
…t set If the backend does not receive a value, or receives a null value, it will not update the database. This is an issue for many other values too, but as an API level fix will be needed, for now this patch only addresses the fields we've received reports about. To make the patch a little easier, Create now calls CreateCheck, Update UpdateCheck and Delete DeleteCheck. The latter two were already equivalent. Create and CreateCheck had some differences (mainly that that former would send the request to /v1/checks instead of /v1/checks/<type>), but given how CreateCheck covers all check types, there should be no difference.
sorccu
changed the title
sorccu
deleted the
simokinnunen/sc-23129/checkly-go-sdk-omitempty-for-locations-causes
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When
omitemptyis specified for a property, the property is not sent to the server. OurPUTendpoints however act likePATCHwould, meaning that partial updates are supported. When a property is not set, it is kept intact, even though the intention most likely was to remove it. Furthermore, usingnullvalue causes the same behavior as if the property was never given, so removingomitemptyis not enough. Instead, we force emptyLocationsandPrivateLocationsto always be sent as[]by initializing them as empty slices if not set.The same issue likely exists for all other slices that have been marked
omitempty. Whether they can also be changed or not requires some additional research. For now, only these two properties have been changed.Affected Components
Style
go fmtNotes for the Reviewer
New Dependency Submission