Add comprehensive godoc documentation to all exported symbols
- Document all exported types, functions, methods, and constants across 52 files - Add package-level doc comments to client, models, utils, and ynison packages - Document HTTP method and endpoint path for each API client method - Document model struct fields and DeJSON/DeList/ToJSON/ToMap methods - Fix duplicate package doc comment in internal/models/base.go Co-Authored-By: Claude Code <noreply@anthropic.com>
This commit is contained in:
1 parent
7a68ad86cb
commit
0456ca0665
54 files changed
+1097
-652
No files matched your search
+13
-24
@@ -1,3 +1,4 @@
|
||||
// Package client provides methods for interacting with Yandex Music API endpoints.
|
||||
package client
|
||||
|
||||
import (
|
||||
@@ -7,8 +8,7 @@ import (
|
||||
"gitea.mrixs.me/Mrixs/yandex-music-api-go/internal/models"
|
||||
)
|
||||
|
||||
// LikeTrack likes a track
|
||||
// POST /users/me/likes/tracks/add-multiple
|
||||
// LikeTrack likes a track (POST /users/me/likes/tracks/add-multiple).
|
||||
func (c *Client) LikeTrack(ctx context.Context, trackID string) error {
|
||||
params := map[string]string{
|
||||
"track-ids": trackID,
|
||||
@@ -17,8 +17,7 @@ func (c *Client) LikeTrack(ctx context.Context, trackID string) error {
|
||||
return c.request.Post(ctx, "/users/me/likes/tracks/add-multiple", params, &result)
|
||||
}
|
||||
|
||||
// UnlikeTrack unlikes a track
|
||||
// POST /users/me/likes/tracks/remove
|
||||
// UnlikeTrack unlikes a track (POST /users/me/likes/tracks/remove).
|
||||
func (c *Client) UnlikeTrack(ctx context.Context, trackID string) error {
|
||||
params := map[string]string{
|
||||
"track-ids": trackID,
|
||||
@@ -27,8 +26,7 @@ func (c *Client) UnlikeTrack(ctx context.Context, trackID string) error {
|
||||
return c.request.Post(ctx, "/users/me/likes/tracks/remove", params, &result)
|
||||
}
|
||||
|
||||
// LikeAlbum likes an album
|
||||
// POST /users/me/likes/albums/add-multiple
|
||||
// LikeAlbum likes an album (POST /users/me/likes/albums/add-multiple).
|
||||
func (c *Client) LikeAlbum(ctx context.Context, albumID string) error {
|
||||
params := map[string]string{
|
||||
"album-ids": albumID,
|
||||
@@ -37,8 +35,7 @@ func (c *Client) LikeAlbum(ctx context.Context, albumID string) error {
|
||||
return c.request.Post(ctx, "/users/me/likes/albums/add-multiple", params, &result)
|
||||
}
|
||||
|
||||
// UnlikeAlbum unlikes an album
|
||||
// POST /users/me/likes/albums/remove
|
||||
// UnlikeAlbum unlikes an album (POST /users/me/likes/albums/remove).
|
||||
func (c *Client) UnlikeAlbum(ctx context.Context, albumID string) error {
|
||||
params := map[string]string{
|
||||
"album-ids": albumID,
|
||||
@@ -47,8 +44,7 @@ func (c *Client) UnlikeAlbum(ctx context.Context, albumID string) error {
|
||||
return c.request.Post(ctx, "/users/me/likes/albums/remove", params, &result)
|
||||
}
|
||||
|
||||
// LikeArtist likes an artist
|
||||
// POST /users/me/likes/artists/add-multiple
|
||||
// LikeArtist likes an artist (POST /users/me/likes/artists/add-multiple).
|
||||
func (c *Client) LikeArtist(ctx context.Context, artistID string) error {
|
||||
params := map[string]string{
|
||||
"artist-ids": artistID,
|
||||
@@ -57,8 +53,7 @@ func (c *Client) LikeArtist(ctx context.Context, artistID string) error {
|
||||
return c.request.Post(ctx, "/users/me/likes/artists/add-multiple", params, &result)
|
||||
}
|
||||
|
||||
// UnlikeArtist unlikes an artist
|
||||
// POST /users/me/likes/artists/remove
|
||||
// UnlikeArtist unlikes an artist (POST /users/me/likes/artists/remove).
|
||||
func (c *Client) UnlikeArtist(ctx context.Context, artistID string) error {
|
||||
params := map[string]string{
|
||||
"artist-ids": artistID,
|
||||
@@ -67,8 +62,7 @@ func (c *Client) UnlikeArtist(ctx context.Context, artistID string) error {
|
||||
return c.request.Post(ctx, "/users/me/likes/artists/remove", params, &result)
|
||||
}
|
||||
|
||||
// LikePlaylist likes a playlist
|
||||
// POST /users/me/likes/playlists/add-multiple
|
||||
// LikePlaylist likes a playlist (POST /users/me/likes/playlists/add-multiple).
|
||||
func (c *Client) LikePlaylist(ctx context.Context, kind int) error {
|
||||
params := map[string]string{
|
||||
"playlist-ids": fmt.Sprintf("%d", kind),
|
||||
@@ -77,8 +71,7 @@ func (c *Client) LikePlaylist(ctx context.Context, kind int) error {
|
||||
return c.request.Post(ctx, "/users/me/likes/playlists/add-multiple", params, &result)
|
||||
}
|
||||
|
||||
// UnlikePlaylist unlikes a playlist
|
||||
// POST /users/me/likes/playlists/remove
|
||||
// UnlikePlaylist unlikes a playlist (POST /users/me/likes/playlists/remove).
|
||||
func (c *Client) UnlikePlaylist(ctx context.Context, kind int) error {
|
||||
params := map[string]string{
|
||||
"playlist-ids": fmt.Sprintf("%d", kind),
|
||||
@@ -87,8 +80,7 @@ func (c *Client) UnlikePlaylist(ctx context.Context, kind int) error {
|
||||
return c.request.Post(ctx, "/users/me/likes/playlists/remove", params, &result)
|
||||
}
|
||||
|
||||
// GetLikedTracks gets user's liked tracks
|
||||
// GET /users/me/likes/tracks
|
||||
// GetLikedTracks gets the user's liked tracks (GET /users/me/likes/tracks).
|
||||
func (c *Client) GetLikedTracks(ctx context.Context) ([]*models.Track, error) {
|
||||
var result []models.Track
|
||||
if err := c.request.Get(ctx, "/users/me/likes/tracks", nil, &result); err != nil {
|
||||
@@ -103,8 +95,7 @@ func (c *Client) GetLikedTracks(ctx context.Context) ([]*models.Track, error) {
|
||||
return tracks, nil
|
||||
}
|
||||
|
||||
// GetLikedAlbums gets user's liked albums
|
||||
// GET /users/me/likes/albums
|
||||
// GetLikedAlbums gets the user's liked albums (GET /users/me/likes/albums).
|
||||
func (c *Client) GetLikedAlbums(ctx context.Context) ([]*models.Album, error) {
|
||||
var result []models.Album
|
||||
if err := c.request.Get(ctx, "/users/me/likes/albums", nil, &result); err != nil {
|
||||
@@ -119,8 +110,7 @@ func (c *Client) GetLikedAlbums(ctx context.Context) ([]*models.Album, error) {
|
||||
return albums, nil
|
||||
}
|
||||
|
||||
// GetLikedArtists gets user's liked artists
|
||||
// GET /users/me/likes/artists
|
||||
// GetLikedArtists gets the user's liked artists (GET /users/me/likes/artists).
|
||||
func (c *Client) GetLikedArtists(ctx context.Context) ([]*models.Artist, error) {
|
||||
var result []models.Artist
|
||||
if err := c.request.Get(ctx, "/users/me/likes/artists", nil, &result); err != nil {
|
||||
@@ -135,8 +125,7 @@ func (c *Client) GetLikedArtists(ctx context.Context) ([]*models.Artist, error)
|
||||
return artists, nil
|
||||
}
|
||||
|
||||
// GetLikedPlaylists gets user's liked playlists
|
||||
// GET /users/me/likes/playlists
|
||||
// GetLikedPlaylists gets the user's liked playlists (GET /users/me/likes/playlists).
|
||||
func (c *Client) GetLikedPlaylists(ctx context.Context) ([]*models.Playlist, error) {
|
||||
var result []models.Playlist
|
||||
if err := c.request.Get(ctx, "/users/me/likes/playlists", nil, &result); err != nil {
|
||||
|
||||
Reference in new issue
Block a user