Skip to content

feat: add include_groups parameter to GetArtistsAlbumsRequest #419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dargmuesli merged 2 commits into from
Jul 23, 2025
Merged

feat: add include_groups parameter to GetArtistsAlbumsRequest #419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51158fe
feat: add include_groups filter to GetArtistsAlbumsRequest and deprec…
julius-d Jun 14, 2025
4c411f1
ci: trigger
dargmuesli Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/main/java/se/michaelthelin/spotify/requests/data/artists/GetArtistsAlbumsRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,30 @@ public Builder id(final String id) {
* supplied, all album types will be returned. Valid values are: {@code album}, {@code single},
* {@code appears_on} and {@code compilation}.
* @return A {@link GetArtistsAlbumsRequest.Builder}.
* @deprecated Use {@link #include_groups(String)} instead.
*/
@Deprecated
public Builder album_type(final String album_type) {
assert (album_type != null);
assert (album_type.matches("((^|,)(single|album|appears_on|compilation))+$"));
return setQueryParameter("album_type", album_type);
}

/**
* The include groups filter setter.
*
* @param include_groups Optional. A comma-separated list of keywords that will be used to filter the response. If not
* supplied, all album types will be returned. Valid values are: {@code album}, {@code single},
* {@code appears_on} and {@code compilation}.
* @return A {@link GetArtistsAlbumsRequest.Builder}.
* @see <a href="https://developer.spotify.com/documentation/web-api/reference/get-an-artists-albums">Spotify Web API References / Get Artist's Albums</a>
*/
public Builder include_groups(final String include_groups) {
assert (include_groups != null);
assert (include_groups.matches("((^|,)(single|album|appears_on|compilation))+$"));
return setQueryParameter("include_groups", include_groups);
}

/**
* The market filter setter.
*
Expand Down
4 changes: 2 additions & 2 deletions ...test/java/se/michaelthelin/spotify/requests/data/artists/GetArtistsAlbumsRequestTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public class GetArtistsAlbumsRequestTest extends AbstractDataTest<Paging<AlbumSi
.setHttpManager(
TestUtil.MockedHttpManager.returningJson(
"requests/data/artists/GetArtistsAlbumsRequest.json"))
.album_type(ITest.ALBUM_TYPE)
.include_groups(ITest.ALBUM_TYPE)
.limit(ITest.LIMIT)
.market(ITest.MARKET)
.offset(ITest.OFFSET)
Expand All @@ -35,7 +35,7 @@ public GetArtistsAlbumsRequestTest() throws Exception {
public void shouldComplyWithReference() {
assertHasAuthorizationHeader(defaultRequest);
assertEquals(
"https://api.spotify.com:443/v1/artists/0LcJLqbBmaGUft1e9Mm8HV/albums?album_type=album&limit=10&market=SE&offset=0",
"https://api.spotify.com:443/v1/artists/0LcJLqbBmaGUft1e9Mm8HV/albums?include_groups=album&limit=10&market=SE&offset=0",
defaultRequest.getUri().toString());
}

Expand Down