Skip to content
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

Jump to bottom

Update Spotify API client interface documentation and parameters #970

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Spotify API client interface documentation and parameters #970

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
54 changes: 26 additions & 28 deletions SpotifyAPI.Web/Clients/Interfaces/IArtistsClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@ public interface IArtistsClient
/// Get Spotify catalog information for several artists based on their Spotify IDs.
/// </summary>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-multiple-artists
/// https://developer.spotify.com/documentation/web-api/reference/get-multiple-artists
/// </remarks>
/// <param name="request">The request-model which contains required and optional parameters</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <param name="request">The request-model that contains required and optional parameters.</param>
/// <param name="cancel">The cancellation-token to allow the request to be cancelled.</param>
/// <returns></returns>
Task<ArtistsResponse> GetSeveral(ArtistsRequest request, CancellationToken cancel = default);

/// <summary>
/// Get Spotify catalog information for a single artist identified by their unique Spotify ID.
/// </summary>
/// <param name="artistId">The Spotify ID of the artist.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <param name="cancel">The cancellation-token to allow the request to be cancelled.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-an-artist
/// https://developer.spotify.com/documentation/web-api/reference/get-an-artist
/// </remarks>
/// <returns></returns>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
Expand All @@ -35,61 +35,58 @@ public interface IArtistsClient
/// Get Spotify catalog information for a single artist identified by their unique Spotify ID.
/// </summary>
/// <param name="artistId">The Spotify ID of the artist.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <param name="request">The request-model which contains optional parameters.</param>
/// <param name="cancel">The cancellation-token to allow the request to be cancelled.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-an-artist
/// https://developer.spotify.com/documentation/web-api/reference/get-an-artist
/// </remarks>
/// <returns></returns>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716")]
Task<FullArtist> Get(string artistId, ArtistRequest request, CancellationToken cancel = default);

/// <summary>
/// Get Spotify catalog information about an artist’s albums.
/// Optional parameters can be specified in the query string to filter and sort the response.
/// Get Spotify catalog information about an artist's albums.
/// </summary>
/// <param name="artistId">The Spotify ID for the artist.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <param name="cancel">The cancellation-token to allow the request to be cancelled.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-an-artists-albums
/// https://developer.spotify.com/documentation/web-api/reference/get-an-artists-albums
/// </remarks>
/// <returns></returns>
Task<Paging<SimpleAlbum>> GetAlbums(string artistId, CancellationToken cancel = default);

/// <summary>
/// Get Spotify catalog information about an artist’s albums.
/// Optional parameters can be specified in the query string to filter and sort the response.
/// </summary>
/// <param name="artistId">The Spotify ID for the artist.</param>
/// <param name="request">The request-model which contains required and optional parameters</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <param name="request">The request-model which contains optional parameters.</param>
/// <param name="cancel">The cancellation-token to allow the request to be cancelled.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-an-artists-albums
/// https://developer.spotify.com/documentation/web-api/reference/get-an-artists-albums
/// </remarks>
/// <returns></returns>
Task<Paging<SimpleAlbum>> GetAlbums(string artistId, ArtistsAlbumsRequest request, CancellationToken cancel = default);



Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The lint seems to fail because of some extra whitespaces on "empty" lines.

/// <summary>
/// Get Spotify catalog information about an artist’s top tracks by country.
/// </summary>
/// <param name="artistId">The Spotify ID for the artist</param>
/// <param name="artistId">The Spotify ID for the artist.</param>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <param name="cancel">The cancellation-token to allow the request to be cancelled.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-an-artists-top-tracks
/// https://developer.spotify.com/documentation/web-api/reference/get-an-artists-top-tracks
/// </remarks>
/// <returns></returns>
Task<ArtistsTopTracksResponse> GetTopTracks(string artistId, ArtistsTopTracksRequest request, CancellationToken cancel = default);


/// <summary>
/// Get Spotify catalog information about artists similar to a given artist.
/// Similarity is based on analysis of the Spotify community’s listening history.
/// Get Spotify catalog information about artists similar to a given artist. Similarity is based on analysis of the
/// Spotify community's listening history.
/// </summary>
/// <param name="artistId">The Spotify ID for the artist</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <param name="artistId">The Spotify ID for the artist.</param>
/// <param name="cancel">The cancellation-token to allow the request to be cancelled.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-an-artists-related-artists
/// https://developer.spotify.com/documentation/web-api/reference/get-an-artists-related-artists
/// </remarks>
/// <returns></returns>
Task<ArtistsRelatedArtistsResponse> GetRelatedArtists(string artistId, CancellationToken cancel = default);
Expand All @@ -98,8 +95,9 @@ public interface IArtistsClient
/// Get Spotify catalog information about artists similar to a given artist.
/// Similarity is based on analysis of the Spotify community’s listening history.
/// </summary>
/// <param name="artistId">The Spotify ID for the artist</param>
/// <param name="cancel">The cancellation-token to allow to cancel the request.</param>
/// <param name="artistId">The Spotify ID for the artist.</param>
/// <param name="request">The request-model which contains required and optional parameters.</param>
/// <param name="cancel">The cancellation-token to allow the request to be cancelled.</param>
/// <remarks>
/// https://developer.spotify.com/documentation/web-api/reference-beta/#endpoint-get-an-artists-related-artists
/// </remarks>
Expand Down
Loading