Repository navigation
docs: add a v9 to v10 migration guide - #471
Merged
Merged
Conversation
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## beta #471 +/- ##
============================================
+ Coverage 48.73% 48.93% +0.19%
- Complexity 712 716 +4
============================================
Files 325 325
Lines 11177 11195 +18
Branches 1317 1319 +2
============================================
+ Hits 5447 5478 +31
+ Misses 4711 4696 -15
- Partials 1019 1021 +2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Merged
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
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.
9.4.0 users have no written upgrade path. This adds one.
The guide covers the 9.4.0 to 10.0.0 surface: 41 renamed methods and request classes, 25 package moves, the model object getters that were renamed or dropped, and what is new. It opens with the handful of changes a clean compile does not catch, the worst being
addItemsToPlaylist, which keeps its signature but now posts to/itemsinstead of/tracks.Every table was generated by diffing the
SpotifyApisurface of the 9.4.0 tag against this branch and matching on HTTP verb plus endpoint path, so the mapping comes from the code rather than from memory. Three pairs the path match could not separate (searchItem,reorderPlaylistsItems,replacePlaylistsItems) were resolved by hand.ci/check-docs.pygained a check that keeps the guide from going stale: every identifier on the 10.0.0 side of a table, and every method in a// v10snippet, must exist in the code, and its warning marker must match the@Deprecatedon the request class. Columns headed "v9" and lines under a// v9marker describe a released past and are left alone. This proves the names exist, not that a mapping is the right one, so a wrong-but-existing target would still pass. One prose mention ofgetAvailableMarketsresolves through the v9 name set rather than the code, because the same name is both a removed model getter and a live deprecated request builder.The guide reports that
Album.getExternalIds()andTrack.getExternalIds()are gone in v10, even thoughexternal_idsis still a required, non-deprecated property on both objects inspec/openapi.yaml. #472 restores the getters and removes that note, and is stacked on this branch.395 tests pass, the javadoc build is clean, and
ci/check-docs.pypasses at both commits.