Documentation
¶
Index ¶
- func RegisterRoutesWithGroup(g *echo.Group, db *bun.DB, authMiddleware *auth.Middleware)
- type CreateLibraryPayload
- type ListLibrariesOptions
- type ListLibrariesQuery
- type RetrieveLibraryOptions
- type Service
- func (svc *Service) CreateLibrary(ctx context.Context, library *models.Library) error
- func (svc *Service) ListLibraries(ctx context.Context, opts ListLibrariesOptions) ([]*models.Library, error)
- func (svc *Service) ListLibrariesWithTotal(ctx context.Context, opts ListLibrariesOptions) ([]*models.Library, int, error)
- func (svc *Service) RetrieveLibrary(ctx context.Context, opts RetrieveLibraryOptions) (*models.Library, error)
- func (svc *Service) UpdateLibrary(ctx context.Context, library *models.Library, opts UpdateLibraryOptions) error
- type UpdateLibraryOptions
- type UpdateLibraryPayload
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterRoutesWithGroup ¶
RegisterRoutesWithGroup registers library routes on a pre-configured group.
Types ¶
type CreateLibraryPayload ¶
type CreateLibraryPayload struct {
Name string `json:"name" validate:"required,max=100"`
OrganizeFileStructure *bool `json:"organize_file_structure,omitempty"`
CoverAspectRatio string `json:"cover_aspect_ratio" validate:"required,oneof=book audiobook book_fallback_audiobook audiobook_fallback_book"`
DownloadFormatPreference *string `json:"download_format_preference,omitempty" validate:"omitempty,oneof=original kepub ask"`
LibraryPaths []string `json:"library_paths" validate:"required,min=1,max=50,dive"`
}
type ListLibrariesOptions ¶
type ListLibrariesQuery ¶
type RetrieveLibraryOptions ¶
type RetrieveLibraryOptions struct {
ID *int
}
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
func NewService ¶
func (*Service) CreateLibrary ¶
func (*Service) ListLibraries ¶
func (*Service) ListLibrariesWithTotal ¶
func (*Service) RetrieveLibrary ¶
func (*Service) UpdateLibrary ¶
type UpdateLibraryOptions ¶
type UpdateLibraryPayload ¶
type UpdateLibraryPayload struct {
Name *string `json:"name,omitempty" validate:"omitempty,max=100"`
OrganizeFileStructure *bool `json:"organize_file_structure,omitempty"`
CoverAspectRatio *string `json:"cover_aspect_ratio,omitempty" validate:"omitempty,oneof=book audiobook book_fallback_audiobook audiobook_fallback_book"`
DownloadFormatPreference *string `json:"download_format_preference,omitempty" validate:"omitempty,oneof=original kepub ask"`
LibraryPaths []string `json:"library_paths,omitempty" validate:"omitempty,min=1,max=50,dive"`
Deleted *bool `json:"deleted,omitempty" validate:"omitempty"`
}
Click to show internal directories.
Click to hide internal directories.