[5.x.x] NotesApi: fix createMergeRequestNote() API breakage introduced in 5.8.0 #1305
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
Even when the new `created_at` and `internal` arguments are marked as "optional", that doesn't mean one can simply omit them from argument list. This means `createMergeRequestNote()`'s function signature has been changed, which is a breaking change which happens without major version bump. So add a wrapper function with the old signature that calls the new signature, which restores compatibility to un-migrated code. IMO this change is not needed for 6.x.x line, as that can be seen as major update and API breakage is fine that way. Although, I'll admit that with 5.8.0 released over a year ago, I'm not sure if this still matters anymore... Fixes: 60259a6 ("Add attributes "created_at", "internal" for NotesApi commits and DiscussionApi merge requests (gitlab4j#1194)")
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.
Even when the new
created_atandinternalarguments are marked as "optional", that doesn't mean one can simply omit them from argument list. This meanscreateMergeRequestNote()'s function signature has been changed, which is a breaking change which happens without major version bump.So add a wrapper function with the old signature that calls the new signature, which restores compatibility to un-migrated code.
IMO this change is not needed for 6.x.x line, as that can be seen as major update and API breakage is fine that way. Although, I'll admit that with 5.8.0 released over a year ago, I'm not sure if this still matters anymore...
Fixes: 60259a6 ("Add attributes "created_at", "internal" for NotesApi commits and DiscussionApi merge requests (#1194)")