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
+31
-19
@@ -1,3 +1,4 @@
|
||||
// Package utils provides utility functions for the Yandex Music API client.
|
||||
package utils
|
||||
|
||||
import (
|
||||
@@ -5,19 +6,20 @@ import (
|
||||
"errors"
|
||||
)
|
||||
|
||||
// Response represents an API response
|
||||
// Response represents an API response from the Yandex Music API.
|
||||
type Response struct {
|
||||
Result json.RawMessage `json:"result"`
|
||||
Error string `json:"error,omitempty"`
|
||||
ErrorDescription string `json:"errorDescription,omitempty"`
|
||||
}
|
||||
|
||||
// GetResult returns the result as raw JSON
|
||||
// GetResult returns the result as raw JSON.
|
||||
func (r *Response) GetResult() json.RawMessage {
|
||||
return r.Result
|
||||
}
|
||||
|
||||
// GetError returns the error message
|
||||
// GetError returns the error message from the response.
|
||||
// It returns Error if set, otherwise ErrorDescription, or "Unknown error" if neither is set.
|
||||
func (r *Response) GetError() string {
|
||||
if r.Error != "" {
|
||||
return r.Error
|
||||
@@ -28,12 +30,13 @@ func (r *Response) GetError() string {
|
||||
return "Unknown error"
|
||||
}
|
||||
|
||||
// HasError returns true if the response contains an error
|
||||
// HasError returns true if the response contains an error.
|
||||
func (r *Response) HasError() bool {
|
||||
return r.Error != "" || r.ErrorDescription != ""
|
||||
}
|
||||
|
||||
// UnmarshalJSON implements custom unmarshaling
|
||||
// UnmarshalJSON implements custom unmarshaling for Response.
|
||||
// If result is missing, the whole response is wrapped in result.
|
||||
func (r *Response) UnmarshalJSON(data []byte) error {
|
||||
// First try to unmarshal as a standard response
|
||||
type Alias Response
|
||||
@@ -53,7 +56,7 @@ func (r *Response) UnmarshalJSON(data []byte) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// DeJSON creates a Response from JSON data
|
||||
// DeJSON creates a Response from JSON data.
|
||||
func DeJSON(data []byte) (*Response, error) {
|
||||
var resp Response
|
||||
if err := json.Unmarshal(data, &resp); err != nil {
|
||||
@@ -62,22 +65,30 @@ func DeJSON(data []byte) (*Response, error) {
|
||||
return &resp, nil
|
||||
}
|
||||
|
||||
// Error types
|
||||
// Error types for the Yandex Music API client.
|
||||
var (
|
||||
ErrUnauthorized = errors.New("unauthorized")
|
||||
ErrBadRequest = errors.New("bad request")
|
||||
ErrNotFound = errors.New("not found")
|
||||
ErrNetwork = errors.New("network error")
|
||||
ErrTimeout = errors.New("timeout")
|
||||
// ErrUnauthorized is returned when authentication fails (HTTP 401/403).
|
||||
ErrUnauthorized = errors.New("unauthorized")
|
||||
// ErrBadRequest is returned when the request is malformed (HTTP 400).
|
||||
ErrBadRequest = errors.New("bad request")
|
||||
// ErrNotFound is returned when the requested resource is not found (HTTP 404).
|
||||
ErrNotFound = errors.New("not found")
|
||||
// ErrNetwork is returned for network-related errors.
|
||||
ErrNetwork = errors.New("network error")
|
||||
// ErrTimeout is returned when a request times out.
|
||||
ErrTimeout = errors.New("timeout")
|
||||
// ErrSchemaMismatch is returned when the API response schema doesn't match expectations.
|
||||
ErrSchemaMismatch = errors.New("schema mismatch")
|
||||
)
|
||||
|
||||
// YandexMusicError is the base error type
|
||||
// YandexMusicError is the base error type for Yandex Music API errors.
|
||||
// It wraps an underlying error with a descriptive message.
|
||||
type YandexMusicError struct {
|
||||
Message string
|
||||
Err error
|
||||
}
|
||||
|
||||
// Error returns the error message, including the wrapped error if present.
|
||||
func (e *YandexMusicError) Error() string {
|
||||
if e.Err != nil {
|
||||
return e.Message + ": " + e.Err.Error()
|
||||
@@ -85,16 +96,17 @@ func (e *YandexMusicError) Error() string {
|
||||
return e.Message
|
||||
}
|
||||
|
||||
// Unwrap returns the underlying error for compatibility with errors.Is and errors.As.
|
||||
func (e *YandexMusicError) Unwrap() error {
|
||||
return e.Err
|
||||
}
|
||||
|
||||
// NewYandexMusicError creates a new YandexMusicError
|
||||
// NewYandexMusicError creates a new YandexMusicError with the given message and underlying error.
|
||||
func NewYandexMusicError(message string, err error) *YandexMusicError {
|
||||
return &YandexMusicError{Message: message, Err: err}
|
||||
}
|
||||
|
||||
// IsUnauthorizedError checks if error is unauthorized
|
||||
// IsUnauthorizedError checks if an error is an unauthorized error.
|
||||
func IsUnauthorizedError(err error) bool {
|
||||
var yme *YandexMusicError
|
||||
if errors.As(err, &yme) {
|
||||
@@ -103,7 +115,7 @@ func IsUnauthorizedError(err error) bool {
|
||||
return errors.Is(err, ErrUnauthorized)
|
||||
}
|
||||
|
||||
// IsBadRequestError checks if error is bad request
|
||||
// IsBadRequestError checks if an error is a bad request error.
|
||||
func IsBadRequestError(err error) bool {
|
||||
var yme *YandexMusicError
|
||||
if errors.As(err, &yme) {
|
||||
@@ -112,7 +124,7 @@ func IsBadRequestError(err error) bool {
|
||||
return errors.Is(err, ErrBadRequest)
|
||||
}
|
||||
|
||||
// IsNotFoundError checks if error is not found
|
||||
// IsNotFoundError checks if an error is a not found error.
|
||||
func IsNotFoundError(err error) bool {
|
||||
var yme *YandexMusicError
|
||||
if errors.As(err, &yme) {
|
||||
@@ -121,7 +133,7 @@ func IsNotFoundError(err error) bool {
|
||||
return errors.Is(err, ErrNotFound)
|
||||
}
|
||||
|
||||
// IsNetworkError checks if error is network error
|
||||
// IsNetworkError checks if an error is a network error.
|
||||
func IsNetworkError(err error) bool {
|
||||
var yme *YandexMusicError
|
||||
if errors.As(err, &yme) {
|
||||
@@ -130,7 +142,7 @@ func IsNetworkError(err error) bool {
|
||||
return errors.Is(err, ErrNetwork)
|
||||
}
|
||||
|
||||
// IsTimeoutError checks if error is timeout
|
||||
// IsTimeoutError checks if an error is a timeout error.
|
||||
func IsTimeoutError(err error) bool {
|
||||
var yme *YandexMusicError
|
||||
if errors.As(err, &yme) {
|
||||
|
||||
Reference in new issue
Block a user