Update the mappings to match current API results #50
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
The current API seems to return a single ID instead of a list.
While originally you only got a count of artists for each country, this has now been expanded to also provide basic information about those artists.
As part of this, the following breaking changes were made to the API:
- renamed `IFetchedListens.Timestamp` to `IFetchedListens.Newest` (and
added `IFetchedListens.Oldest`)
- the doc comments were also updated; these timestamps are always the
newest/oldest listens in the entire dataset, not limited to the
requested range
- renamed `IListen.Timestamp` to `IListed.ListenedAt`
- dropped `IFetchedListens.UnixTimestamp` and `IListen.UnixTimestamp`
- only the properties of type `DateTimeOffset` are retained
These are:
- `Credits`, a list of artist credits
- these include the MusicBrainz ID of an artist, the name under which
that artist was credited, and a join phrase which either links to
the next artist in the credit (e.g. "feat.") or ends the credit
(e.g. "and friends")
- `CoverArtId`, the internal ID of the associated entry in the CoverArt
Archive
- `CoverArtReleaseId`, the MusicBrainz ID of the release use for the
associated entry in the CoverArt Archive
- `RecordingName`, the name of the recording in MusicBrainz
This adds the `Credits`, `CoverArtId` and `CoverArtReleaseId` fields, as previously added to the MusicBrainz ID mappings.
Zastai
added
breaking
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.
This adjusts the processing to handle the current structures returned by the ListenBrainz API. This should resolve all cases where the
UnhandledPropertiesfield was non-null before.IArtistCountryInfonow includes anArtistsproperty, which will haveIArtistInfoinstances for all listened-to artists from that countryIArtistInfonow includes anIdproperty, containing a single MusicBrainz IDIdsproperty; once confirmed, that will be marked[Obsolete]IFetchedListensnow has anOldestproperty, containing the timestamp of the user's oldest recorded listenTimestampproperty was renamed toNewestNewesthas been corrected as well; it is the timestamp of the user's newest recorded listen, unrelated to the range returned by that specific callUnixTimestampproperty was dropped (all targeted frameworks allow easy conversion of theDateTimeOffsetto a Unix time value)IListenhas itsTimestampproperty renamed toListenedAt, and theUnixTimestampproperty droppedIMusicBrainzIdMappingshas a newRecordingNamepropertyIArtistCredittype, with information about a MusicBrainz artist creditIMusicBrainzIdMappings,IRecordingInfoandIReleaseInfohave three new properties:CoverArtId: the numeric ID of the associated CoverArt Archive entryCoverArtReleaseId: the MusicBrainz ID of the release linked to the associated CoverArt Archive entryCredits: a list of associated artist creditsFixes #47.