Fix overlapping struct fields & last golint errors #332
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
There have been a few issues filed over the past few years, relative to unexpected or unreliable behavior in the client, due to overlapping struct fields because of an embedded type or conflicting JSON field tags. This could make it appear like some fields are unset, because `encoding/json` has put the value in the overlapped field and not the one the programmer is accessing. Unfortunately, fixing these issues are technically a breaking API change and so we waited to completely fix them until now. In the spirit of making the struct fields consistently named, this also updates the `HttpStatus` field in the `EventResponse` struct to be `HTTPStatus`. This is purely cosmetic, but feels appropriate to do now since the removal if the `Id` field makes it the last one. Fixes #218 Fixes #316 Fixes #268
stmcallister
approved these changes
Oct 11, 2021
theckman
added a commit
that referenced
this pull request
Oct 12, 2021
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.
There have been a few issues filed over the past few years, relative to
unexpected or unreliable behavior in the client, due to overlapping struct
fields because of an embedded type or conflicting JSON field tags. This could
make it appear like some fields are unset, because
encoding/jsonhas put thevalue in the overlapped field and not the one the programmer is accessing.
Unfortunately, fixing these issues are technically a breaking API change and so
we waited to completely fix them until now.
In the spirit of making the struct fields consistently named, this also updates
the
HttpStatusfield in theEventResponsestruct to beHTTPStatus. This ispurely cosmetic, but feels appropriate to do now since the removal if the
Idfield makes it the last one.
Fixes #218
Fixes #316
Fixes #268