apis

Documentation

Index

• Constants
• func AlbumNotFound() *pyrin.Error
• func ArtistNotFound() *pyrin.Error
• func Body[T types.Body](c pyrin.Context) (T, error)
• func ConvertDBAlbum(c pyrin.Context, album database.Album) types.Album
• func ConvertDBTrack(c pyrin.Context, track database.Track) types.Track
• func InstallAlbumHandlers(app core.App, group pyrin.Group)
• func InstallArtistHandlers(app core.App, group pyrin.Group)
• func InstallAuthHandlers(app core.App, group pyrin.Group)
• func InstallHandlers(app core.App, g pyrin.Group)
• func InstallPlaylistHandlers(app core.App, group pyrin.Group)
• func InstallQueueHandlers(app core.App, group pyrin.Group)
• func InstallSystemHandlers(app core.App, group pyrin.Group)
• func InstallTagHandlers(app core.App, group pyrin.Group)
• func InstallTrackHandlers(app core.App, group pyrin.Group)
• func InvalidFilter(err error) *pyrin.Error
• func InvalidSort(err error) *pyrin.Error
• func ParseQueryBool(s string) bool
• func RegisterHandlers(app core.App, router pyrin.Router)
• func Server(app core.App) (*pyrin.Server, error)
• func TrackNotFound() *pyrin.Error
• func User(app core.App, c pyrin.Context) (*database.User, error)
• type Export
• type ExportAlbum
• type ExportArtist
• type ExportTrack
• type PatchAlbumBody
  • func (b PatchAlbumBody) Validate(validator validate.Validator) error
• type PatchTrackBody
  • func (b PatchTrackBody) Validate(validator validate.Validator) error
• type PostAlbumImport
• type PostAlbumImportBody
  • func (PostAlbumImportBody) Schema() jio.Schema
  • func (b PostAlbumImportBody) Validate(validator validate.Validator) error

Constants

const (
	ErrTypeArtistNotFound pyrin.ErrorType = "ARTIST_NOT_FOUND"
	ErrTypeAlbumNotFound  pyrin.ErrorType = "ALBUM_NOT_FOUND"
	ErrTypeTrackNotFound  pyrin.ErrorType = "TRACK_NOT_FOUND"
	ErrTypeInvalidFilter  pyrin.ErrorType = "INVALID_FILTER"
	ErrTypeInvalidSort    pyrin.ErrorType = "INVALID_SORT"
)

Functions

func AlbumNotFound

func AlbumNotFound() *pyrin.Error

func ArtistNotFound

func ArtistNotFound() *pyrin.Error

func Body

func Body[T types.Body](c pyrin.Context) (T, error)

func ConvertDBAlbum

func ConvertDBAlbum(c pyrin.Context, album database.Album) types.Album

func ConvertDBTrack

func ConvertDBTrack(c pyrin.Context, track database.Track) types.Track

func InstallAlbumHandlers

func InstallAlbumHandlers(app core.App, group pyrin.Group)

func InstallArtistHandlers

func InstallArtistHandlers(app core.App, group pyrin.Group)

func InstallAuthHandlers

func InstallAuthHandlers(app core.App, group pyrin.Group)

func InstallHandlers

func InstallHandlers(app core.App, g pyrin.Group)

func InstallPlaylistHandlers

func InstallPlaylistHandlers(app core.App, group pyrin.Group)

func InstallQueueHandlers

func InstallQueueHandlers(app core.App, group pyrin.Group)

TODO(patrik): Add back

func InstallSystemHandlers

func InstallSystemHandlers(app core.App, group pyrin.Group)

func InstallTagHandlers

func InstallTagHandlers(app core.App, group pyrin.Group)

TODO(patrik): Add back

func InstallTrackHandlers

func InstallTrackHandlers(app core.App, group pyrin.Group)

func InvalidFilter

func InvalidFilter(err error) *pyrin.Error

func InvalidSort

func InvalidSort(err error) *pyrin.Error

func ParseQueryBool

func ParseQueryBool(s string) bool

func RegisterHandlers

func RegisterHandlers(app core.App, router pyrin.Router)

func Server

func Server(app core.App) (*pyrin.Server, error)

func TrackNotFound

func TrackNotFound() *pyrin.Error

func User

func User(app core.App, c pyrin.Context) (*database.User, error)

Types

type Export

type Export struct {
	Artists []ExportArtist
	Albums  []ExportAlbum
	Tracks  []ExportTrack
}

type ExportAlbum

type ExportAlbum struct {
	Id       string
	Name     string
	ArtistId string

	CoverArt string
	Year     int64
}

type ExportArtist

type ExportArtist struct {
	Id      string
	Name    string
	Picture string
}

type ExportTrack

type ExportTrack struct {
	Id   string
	Name string

	AlbumId  string
	ArtistId string

	Number   int64
	Duration int64
	Year     int64

	ExportName       string
	OriginalFilename string
	MobileFilename   string

	Created int64

	Tags []string
}

type PatchAlbumBody

type PatchAlbumBody struct {
	Name       *string `json:"name"`
	ArtistId   *string `json:"artistId"`
	ArtistName *string `json:"artistName"`
	Year       *int64  `json:"year"`
}

func (PatchAlbumBody) Validate

func (b PatchAlbumBody) Validate(validator validate.Validator) error

type PatchTrackBody

type PatchTrackBody struct {
	Name       *string   `json:"name,omitempty"`
	ArtistId   *string   `json:"artistId,omitempty"`
	ArtistName *string   `json:"artistName,omitempty"`
	Year       *int64    `json:"year,omitempty"`
	Number     *int64    `json:"number,omitempty"`
	Tags       *[]string `json:"tags,omitempty"`
}

func (PatchTrackBody) Validate

func (b PatchTrackBody) Validate(validator validate.Validator) error

Validate implements pyrin.Body.

type PostAlbumImport

type PostAlbumImport struct {
	AlbumId string `json:"albumId"`
}

type PostAlbumImportBody

type PostAlbumImportBody struct {
	Name   string `json:"name"`
	Artist string `json:"artist"`
}

func (PostAlbumImportBody) Schema

func (PostAlbumImportBody) Schema() jio.Schema

func (PostAlbumImportBody) Validate

func (b PostAlbumImportBody) Validate(validator validate.Validator) error