Documentation
¶
Overview ¶
Package api serves the server's HTTP surface: the REST API under /api/v1 (generated from api/openapi.yaml), the health probes, the metrics and, later, the event stream and the web app.
Index ¶
- Constants
- func ClientIP(ctx context.Context) string
- func NewHandler(deps Deps) (http.Handler, error)
- func RequestID(ctx context.Context) string
- type Check
- type Deps
- type Problem
- type Server
- func (s *Server) AcceptInvite(ctx context.Context, req apigen.AcceptInviteRequestObject) (apigen.AcceptInviteResponseObject, error)
- func (s *Server) AddFromSource(ctx context.Context, req apigen.AddFromSourceRequestObject) (apigen.AddFromSourceResponseObject, error)
- func (s *Server) AddToLibrary(ctx context.Context, req apigen.AddToLibraryRequestObject) (apigen.AddToLibraryResponseObject, error)
- func (s *Server) AssignNetworkProfile(ctx context.Context, req apigen.AssignNetworkProfileRequestObject) (apigen.AssignNetworkProfileResponseObject, error)
- func (s *Server) AttachCandidate(ctx context.Context, req apigen.AttachCandidateRequestObject) (apigen.AttachCandidateResponseObject, error)
- func (s *Server) AttachSeries(ctx context.Context, req apigen.AttachSeriesRequestObject) (apigen.AttachSeriesResponseObject, error)
- func (s *Server) BrowseCatalog(ctx context.Context, req apigen.BrowseCatalogRequestObject) (apigen.BrowseCatalogResponseObject, error)
- func (s *Server) CancelJobRun(ctx context.Context, req apigen.CancelJobRunRequestObject) (apigen.CancelJobRunResponseObject, error)
- func (s *Server) CancelMetaJobRun(ctx context.Context, req apigen.CancelMetaJobRunRequestObject) (apigen.CancelMetaJobRunResponseObject, error)
- func (s *Server) CancelPluginJobRun(ctx context.Context, req apigen.CancelPluginJobRunRequestObject) (apigen.CancelPluginJobRunResponseObject, error)
- func (s *Server) CancelTask(ctx context.Context, req apigen.CancelTaskRequestObject) (apigen.CancelTaskResponseObject, error)
- func (s *Server) ChangeMyPassword(ctx context.Context, req apigen.ChangeMyPasswordRequestObject) (apigen.ChangeMyPasswordResponseObject, error)
- func (s *Server) CheckInvite(ctx context.Context, req apigen.CheckInviteRequestObject) (apigen.CheckInviteResponseObject, error)
- func (s *Server) CheckMetaConnection(ctx context.Context, _ apigen.CheckMetaConnectionRequestObject) (apigen.CheckMetaConnectionResponseObject, error)
- func (s *Server) ClearMyHistory(ctx context.Context, _ apigen.ClearMyHistoryRequestObject) (apigen.ClearMyHistoryResponseObject, error)
- func (s *Server) ClearPackageImageRetries(ctx context.Context, req apigen.ClearPackageImageRetriesRequestObject) (apigen.ClearPackageImageRetriesResponseObject, error)
- func (s *Server) ClearSourceImageRetries(ctx context.Context, req apigen.ClearSourceImageRetriesRequestObject) (apigen.ClearSourceImageRetriesResponseObject, error)
- func (s *Server) CompleteSetup(ctx context.Context, _ apigen.CompleteSetupRequestObject) (apigen.CompleteSetupResponseObject, error)
- func (s *Server) ConfirmMetaDuplicate(ctx context.Context, req apigen.ConfirmMetaDuplicateRequestObject) (apigen.ConfirmMetaDuplicateResponseObject, error)
- func (s *Server) CreateInvite(ctx context.Context, req apigen.CreateInviteRequestObject) (apigen.CreateInviteResponseObject, error)
- func (s *Server) CreateMyApiKey(ctx context.Context, req apigen.CreateMyApiKeyRequestObject) (apigen.CreateMyApiKeyResponseObject, error)
- func (s *Server) CreateNetworkProfile(ctx context.Context, req apigen.CreateNetworkProfileRequestObject) (apigen.CreateNetworkProfileResponseObject, error)
- func (s *Server) CreateProxy(ctx context.Context, req apigen.CreateProxyRequestObject) (apigen.CreateProxyResponseObject, error)
- func (s *Server) CreateSetupAdmin(ctx context.Context, req apigen.CreateSetupAdminRequestObject) (apigen.CreateSetupAdminResponseObject, error)
- func (s *Server) CreateSolver(ctx context.Context, req apigen.CreateSolverRequestObject) (apigen.CreateSolverResponseObject, error)
- func (s *Server) CreateStorage(ctx context.Context, req apigen.CreateStorageRequestObject) (apigen.CreateStorageResponseObject, error)
- func (s *Server) CreateUser(ctx context.Context, req apigen.CreateUserRequestObject) (apigen.CreateUserResponseObject, error)
- func (s *Server) DeleteChapterFile(ctx context.Context, req apigen.DeleteChapterFileRequestObject) (apigen.DeleteChapterFileResponseObject, error)
- func (s *Server) DeleteInvite(ctx context.Context, req apigen.DeleteInviteRequestObject) (apigen.DeleteInviteResponseObject, error)
- func (s *Server) DeleteMyApiKey(ctx context.Context, req apigen.DeleteMyApiKeyRequestObject) (apigen.DeleteMyApiKeyResponseObject, error)
- func (s *Server) DeleteMySession(ctx context.Context, req apigen.DeleteMySessionRequestObject) (apigen.DeleteMySessionResponseObject, error)
- func (s *Server) DeleteNetworkProfile(ctx context.Context, req apigen.DeleteNetworkProfileRequestObject) (apigen.DeleteNetworkProfileResponseObject, error)
- func (s *Server) DeletePlugin(ctx context.Context, req apigen.DeletePluginRequestObject) (apigen.DeletePluginResponseObject, error)
- func (s *Server) DeleteProxy(ctx context.Context, req apigen.DeleteProxyRequestObject) (apigen.DeleteProxyResponseObject, error)
- func (s *Server) DeleteReaderSettings(ctx context.Context, req apigen.DeleteReaderSettingsRequestObject) (apigen.DeleteReaderSettingsResponseObject, error)
- func (s *Server) DeleteSolver(ctx context.Context, req apigen.DeleteSolverRequestObject) (apigen.DeleteSolverResponseObject, error)
- func (s *Server) DeleteStorage(ctx context.Context, req apigen.DeleteStorageRequestObject) (apigen.DeleteStorageResponseObject, error)
- func (s *Server) DeleteUser(ctx context.Context, req apigen.DeleteUserRequestObject) (apigen.DeleteUserResponseObject, error)
- func (s *Server) DetachSeries(ctx context.Context, req apigen.DetachSeriesRequestObject) (apigen.DetachSeriesResponseObject, error)
- func (s *Server) DismissMetaDuplicate(ctx context.Context, req apigen.DismissMetaDuplicateRequestObject) (apigen.DismissMetaDuplicateResponseObject, error)
- func (s *Server) DownloadChapters(ctx context.Context, req apigen.DownloadChaptersRequestObject) (apigen.DownloadChaptersResponseObject, error)
- func (s *Server) GetCatalogEntry(ctx context.Context, req apigen.GetCatalogEntryRequestObject) (apigen.GetCatalogEntryResponseObject, error)
- func (s *Server) GetCatalogEntryCover(ctx context.Context, req apigen.GetCatalogEntryCoverRequestObject) (apigen.GetCatalogEntryCoverResponseObject, error)
- func (s *Server) GetChapterPage(ctx context.Context, req apigen.GetChapterPageRequestObject) (apigen.GetChapterPageResponseObject, error)
- func (s *Server) GetChapterPages(ctx context.Context, req apigen.GetChapterPagesRequestObject) (apigen.GetChapterPagesResponseObject, error)
- func (s *Server) GetJob(ctx context.Context, req apigen.GetJobRequestObject) (apigen.GetJobResponseObject, error)
- func (s *Server) GetJobRun(ctx context.Context, req apigen.GetJobRunRequestObject) (apigen.GetJobRunResponseObject, error)
- func (s *Server) GetMe(ctx context.Context, _ apigen.GetMeRequestObject) (apigen.GetMeResponseObject, error)
- func (s *Server) GetMetaConnection(ctx context.Context, _ apigen.GetMetaConnectionRequestObject) (apigen.GetMetaConnectionResponseObject, error)
- func (s *Server) GetMetaDuplicate(ctx context.Context, req apigen.GetMetaDuplicateRequestObject) (apigen.GetMetaDuplicateResponseObject, error)
- func (s *Server) GetMetaDuplicateJudge(ctx context.Context, _ apigen.GetMetaDuplicateJudgeRequestObject) (apigen.GetMetaDuplicateJudgeResponseObject, error)
- func (s *Server) GetMetaHealth(ctx context.Context, _ apigen.GetMetaHealthRequestObject) (apigen.GetMetaHealthResponseObject, error)
- func (s *Server) GetMetaJob(ctx context.Context, req apigen.GetMetaJobRequestObject) (apigen.GetMetaJobResponseObject, error)
- func (s *Server) GetMetaJobRun(ctx context.Context, req apigen.GetMetaJobRunRequestObject) (apigen.GetMetaJobRunResponseObject, error)
- func (s *Server) GetMetaNetwork(ctx context.Context, _ apigen.GetMetaNetworkRequestObject) (apigen.GetMetaNetworkResponseObject, error)
- func (s *Server) GetMetaSearchEngine(ctx context.Context, _ apigen.GetMetaSearchEngineRequestObject) (apigen.GetMetaSearchEngineResponseObject, error)
- func (s *Server) GetMetaSyncRun(ctx context.Context, req apigen.GetMetaSyncRunRequestObject) (apigen.GetMetaSyncRunResponseObject, error)
- func (s *Server) GetMyHistory(ctx context.Context, req apigen.GetMyHistoryRequestObject) (apigen.GetMyHistoryResponseObject, error)
- func (s *Server) GetMyPreferences(ctx context.Context, _ apigen.GetMyPreferencesRequestObject) (apigen.GetMyPreferencesResponseObject, error)
- func (s *Server) GetMyUpdates(ctx context.Context, req apigen.GetMyUpdatesRequestObject) (apigen.GetMyUpdatesResponseObject, error)
- func (s *Server) GetMyUpdatesStatus(ctx context.Context, _ apigen.GetMyUpdatesStatusRequestObject) (apigen.GetMyUpdatesStatusResponseObject, error)
- func (s *Server) GetNetworkProfile(ctx context.Context, req apigen.GetNetworkProfileRequestObject) (apigen.GetNetworkProfileResponseObject, error)
- func (s *Server) GetPackage(ctx context.Context, req apigen.GetPackageRequestObject) (apigen.GetPackageResponseObject, error)
- func (s *Server) GetPackageIcon(ctx context.Context, req apigen.GetPackageIconRequestObject) (apigen.GetPackageIconResponseObject, error)
- func (s *Server) GetPackageImageRetries(ctx context.Context, req apigen.GetPackageImageRetriesRequestObject) (apigen.GetPackageImageRetriesResponseObject, error)
- func (s *Server) GetPlugin(ctx context.Context, req apigen.GetPluginRequestObject) (apigen.GetPluginResponseObject, error)
- func (s *Server) GetPluginConfig(ctx context.Context, req apigen.GetPluginConfigRequestObject) (apigen.GetPluginConfigResponseObject, error)
- func (s *Server) GetPluginJob(ctx context.Context, req apigen.GetPluginJobRequestObject) (apigen.GetPluginJobResponseObject, error)
- func (s *Server) GetPluginJobRun(ctx context.Context, req apigen.GetPluginJobRunRequestObject) (apigen.GetPluginJobRunResponseObject, error)
- func (s *Server) GetPluginNetwork(ctx context.Context, req apigen.GetPluginNetworkRequestObject) (apigen.GetPluginNetworkResponseObject, error)
- func (s *Server) GetProxy(ctx context.Context, req apigen.GetProxyRequestObject) (apigen.GetProxyResponseObject, error)
- func (s *Server) GetQueue(ctx context.Context, _ apigen.GetQueueRequestObject) (apigen.GetQueueResponseObject, error)
- func (s *Server) GetReaderSettings(ctx context.Context, req apigen.GetReaderSettingsRequestObject) (apigen.GetReaderSettingsResponseObject, error)
- func (s *Server) GetSetup(ctx context.Context, _ apigen.GetSetupRequestObject) (apigen.GetSetupResponseObject, error)
- func (s *Server) GetSolver(ctx context.Context, req apigen.GetSolverRequestObject) (apigen.GetSolverResponseObject, error)
- func (s *Server) GetSourceImageRetries(ctx context.Context, req apigen.GetSourceImageRetriesRequestObject) (apigen.GetSourceImageRetriesResponseObject, error)
- func (s *Server) GetSourceNetwork(ctx context.Context, req apigen.GetSourceNetworkRequestObject) (apigen.GetSourceNetworkResponseObject, error)
- func (s *Server) GetSourceSettings(ctx context.Context, req apigen.GetSourceSettingsRequestObject) (apigen.GetSourceSettingsResponseObject, error)
- func (s *Server) GetSystemHealth(ctx context.Context, _ apigen.GetSystemHealthRequestObject) (apigen.GetSystemHealthResponseObject, error)
- func (s *Server) GetSystemInfo(ctx context.Context, _ apigen.GetSystemInfoRequestObject) (apigen.GetSystemInfoResponseObject, error)
- func (s *Server) GetTask(ctx context.Context, req apigen.GetTaskRequestObject) (apigen.GetTaskResponseObject, error)
- func (s *Server) GetUser(ctx context.Context, req apigen.GetUserRequestObject) (apigen.GetUserResponseObject, error)
- func (s *Server) GetWork(ctx context.Context, req apigen.GetWorkRequestObject) (apigen.GetWorkResponseObject, error)
- func (s *Server) GetWorkChapter(ctx context.Context, req apigen.GetWorkChapterRequestObject) (apigen.GetWorkChapterResponseObject, error)
- func (s *Server) GetWorkCover(ctx context.Context, req apigen.GetWorkCoverRequestObject) (apigen.GetWorkCoverResponseObject, error)
- func (s *Server) GetWorkProgress(ctx context.Context, req apigen.GetWorkProgressRequestObject) (apigen.GetWorkProgressResponseObject, error)
- func (s *Server) InstallPackage(ctx context.Context, req apigen.InstallPackageRequestObject) (apigen.InstallPackageResponseObject, error)
- func (s *Server) ListBookmarks(ctx context.Context, req apigen.ListBookmarksRequestObject) (apigen.ListBookmarksResponseObject, error)
- func (s *Server) ListDownloads(ctx context.Context, req apigen.ListDownloadsRequestObject) (apigen.ListDownloadsResponseObject, error)
- func (s *Server) ListInvites(ctx context.Context, _ apigen.ListInvitesRequestObject) (apigen.ListInvitesResponseObject, error)
- func (s *Server) ListJobRuns(ctx context.Context, req apigen.ListJobRunsRequestObject) (apigen.ListJobRunsResponseObject, error)
- func (s *Server) ListJobs(ctx context.Context, _ apigen.ListJobsRequestObject) (apigen.ListJobsResponseObject, error)
- func (s *Server) ListLibrary(ctx context.Context, req apigen.ListLibraryRequestObject) (apigen.ListLibraryResponseObject, error)
- func (s *Server) ListMetaDuplicates(ctx context.Context, req apigen.ListMetaDuplicatesRequestObject) (apigen.ListMetaDuplicatesResponseObject, error)
- func (s *Server) ListMetaJobRuns(ctx context.Context, req apigen.ListMetaJobRunsRequestObject) (apigen.ListMetaJobRunsResponseObject, error)
- func (s *Server) ListMetaJobs(ctx context.Context, _ apigen.ListMetaJobsRequestObject) (apigen.ListMetaJobsResponseObject, error)
- func (s *Server) ListMetaProviders(ctx context.Context, _ apigen.ListMetaProvidersRequestObject) (apigen.ListMetaProvidersResponseObject, error)
- func (s *Server) ListMetaSyncRuns(ctx context.Context, req apigen.ListMetaSyncRunsRequestObject) (apigen.ListMetaSyncRunsResponseObject, error)
- func (s *Server) ListMyApiKeys(ctx context.Context, _ apigen.ListMyApiKeysRequestObject) (apigen.ListMyApiKeysResponseObject, error)
- func (s *Server) ListMySessions(ctx context.Context, _ apigen.ListMySessionsRequestObject) (apigen.ListMySessionsResponseObject, error)
- func (s *Server) ListNetworkAssignments(ctx context.Context, _ apigen.ListNetworkAssignmentsRequestObject) (apigen.ListNetworkAssignmentsResponseObject, error)
- func (s *Server) ListNetworkProfiles(ctx context.Context, req apigen.ListNetworkProfilesRequestObject) (apigen.ListNetworkProfilesResponseObject, error)
- func (s *Server) ListPackageOrigins(ctx context.Context, req apigen.ListPackageOriginsRequestObject) (apigen.ListPackageOriginsResponseObject, error)
- func (s *Server) ListPackages(ctx context.Context, req apigen.ListPackagesRequestObject) (apigen.ListPackagesResponseObject, error)
- func (s *Server) ListPluginJobRuns(ctx context.Context, req apigen.ListPluginJobRunsRequestObject) (apigen.ListPluginJobRunsResponseObject, error)
- func (s *Server) ListPluginJobs(ctx context.Context, req apigen.ListPluginJobsRequestObject) (apigen.ListPluginJobsResponseObject, error)
- func (s *Server) ListPlugins(ctx context.Context, _ apigen.ListPluginsRequestObject) (apigen.ListPluginsResponseObject, error)
- func (s *Server) ListProxies(ctx context.Context, req apigen.ListProxiesRequestObject) (apigen.ListProxiesResponseObject, error)
- func (s *Server) ListSeriesChapters(ctx context.Context, req apigen.ListSeriesChaptersRequestObject) (apigen.ListSeriesChaptersResponseObject, error)
- func (s *Server) ListSolvers(ctx context.Context, req apigen.ListSolversRequestObject) (apigen.ListSolversResponseObject, error)
- func (s *Server) ListSources(ctx context.Context, req apigen.ListSourcesRequestObject) (apigen.ListSourcesResponseObject, error)
- func (s *Server) ListStorages(ctx context.Context, _ apigen.ListStoragesRequestObject) (apigen.ListStoragesResponseObject, error)
- func (s *Server) ListTasks(ctx context.Context, req apigen.ListTasksRequestObject) (apigen.ListTasksResponseObject, error)
- func (s *Server) ListUsers(ctx context.Context, req apigen.ListUsersRequestObject) (apigen.ListUsersResponseObject, error)
- func (s *Server) ListWorkChapters(ctx context.Context, req apigen.ListWorkChaptersRequestObject) (apigen.ListWorkChaptersResponseObject, error)
- func (s *Server) Login(ctx context.Context, req apigen.LoginRequestObject) (apigen.LoginResponseObject, error)
- func (s *Server) Logout(ctx context.Context, _ apigen.LogoutRequestObject) (apigen.LogoutResponseObject, error)
- func (s *Server) MarkChaptersRead(ctx context.Context, req apigen.MarkChaptersReadRequestObject) (apigen.MarkChaptersReadResponseObject, error)
- func (s *Server) MarkWorkSeen(ctx context.Context, req apigen.MarkWorkSeenRequestObject) (apigen.MarkWorkSeenResponseObject, error)
- func (s *Server) MatchWork(ctx context.Context, req apigen.MatchWorkRequestObject) (apigen.MatchWorkResponseObject, error)
- func (s *Server) MoveStorage(ctx context.Context, req apigen.MoveStorageRequestObject) (apigen.MoveStorageResponseObject, error)
- func (s *Server) PinChapterVariant(ctx context.Context, req apigen.PinChapterVariantRequestObject) (apigen.PinChapterVariantResponseObject, error)
- func (s *Server) PutMetaDuplicateJudge(ctx context.Context, req apigen.PutMetaDuplicateJudgeRequestObject) (apigen.PutMetaDuplicateJudgeResponseObject, error)
- func (s *Server) PutMetaSearchEngine(ctx context.Context, req apigen.PutMetaSearchEngineRequestObject) (apigen.PutMetaSearchEngineResponseObject, error)
- func (s *Server) PutMyPreferences(ctx context.Context, req apigen.PutMyPreferencesRequestObject) (apigen.PutMyPreferencesResponseObject, error)
- func (s *Server) PutReaderSettings(ctx context.Context, req apigen.PutReaderSettingsRequestObject) (apigen.PutReaderSettingsResponseObject, error)
- func (s *Server) RefreshMetaEntry(ctx context.Context, req apigen.RefreshMetaEntryRequestObject) (apigen.RefreshMetaEntryResponseObject, error)
- func (s *Server) RefreshMyUpdates(ctx context.Context, _ apigen.RefreshMyUpdatesRequestObject) (apigen.RefreshMyUpdatesResponseObject, error)
- func (s *Server) RefreshPackageOrigin(ctx context.Context, req apigen.RefreshPackageOriginRequestObject) (apigen.RefreshPackageOriginResponseObject, error)
- func (s *Server) RefreshWork(ctx context.Context, req apigen.RefreshWorkRequestObject) (apigen.RefreshWorkResponseObject, error)
- func (s *Server) RegisterPlugin(ctx context.Context, req apigen.RegisterPluginRequestObject) (apigen.RegisterPluginResponseObject, error)
- func (s *Server) ReloadPackage(ctx context.Context, req apigen.ReloadPackageRequestObject) (apigen.ReloadPackageResponseObject, error)
- func (s *Server) RemoveFromLibrary(ctx context.Context, req apigen.RemoveFromLibraryRequestObject) (apigen.RemoveFromLibraryResponseObject, error)
- func (s *Server) RemoveFromMyHistory(ctx context.Context, req apigen.RemoveFromMyHistoryRequestObject) (apigen.RemoveFromMyHistoryResponseObject, error)
- func (s *Server) ReopenMetaDuplicate(ctx context.Context, req apigen.ReopenMetaDuplicateRequestObject) (apigen.ReopenMetaDuplicateResponseObject, error)
- func (s *Server) ReplaceNetworkProfile(ctx context.Context, req apigen.ReplaceNetworkProfileRequestObject) (apigen.ReplaceNetworkProfileResponseObject, error)
- func (s *Server) ResetMetaDuplicateJudge(ctx context.Context, _ apigen.ResetMetaDuplicateJudgeRequestObject) (apigen.ResetMetaDuplicateJudgeResponseObject, error)
- func (s *Server) ResetMetaSearchEngine(ctx context.Context, _ apigen.ResetMetaSearchEngineRequestObject) (apigen.ResetMetaSearchEngineResponseObject, error)
- func (s *Server) RetryTask(ctx context.Context, req apigen.RetryTaskRequestObject) (apigen.RetryTaskResponseObject, error)
- func (s *Server) RunJob(ctx context.Context, req apigen.RunJobRequestObject) (apigen.RunJobResponseObject, error)
- func (s *Server) RunMetaJob(ctx context.Context, req apigen.RunMetaJobRequestObject) (apigen.RunMetaJobResponseObject, error)
- func (s *Server) RunMetaProviderSync(ctx context.Context, req apigen.RunMetaProviderSyncRequestObject) (apigen.RunMetaProviderSyncResponseObject, error)
- func (s *Server) RunPluginJob(ctx context.Context, req apigen.RunPluginJobRequestObject) (apigen.RunPluginJobResponseObject, error)
- func (s *Server) SearchCatalog(ctx context.Context, req apigen.SearchCatalogRequestObject) (apigen.SearchCatalogResponseObject, error)
- func (s *Server) SearchWorkSource(ctx context.Context, req apigen.SearchWorkSourceRequestObject) (apigen.SearchWorkSourceResponseObject, error)
- func (s *Server) SetAutoDownload(ctx context.Context, req apigen.SetAutoDownloadRequestObject) (apigen.SetAutoDownloadResponseObject, error)
- func (s *Server) SetBookmarks(ctx context.Context, req apigen.SetBookmarksRequestObject) (apigen.SetBookmarksResponseObject, error)
- func (s *Server) SetChapterProgress(ctx context.Context, req apigen.SetChapterProgressRequestObject) (apigen.SetChapterProgressResponseObject, error)
- func (s *Server) SetMetaConnection(ctx context.Context, req apigen.SetMetaConnectionRequestObject) (apigen.SetMetaConnectionResponseObject, error)
- func (s *Server) SetPackageImageRetries(ctx context.Context, req apigen.SetPackageImageRetriesRequestObject) (apigen.SetPackageImageRetriesResponseObject, error)
- func (s *Server) SetPackageLanguages(ctx context.Context, req apigen.SetPackageLanguagesRequestObject) (apigen.SetPackageLanguagesResponseObject, error)
- func (s *Server) SetPluginConfig(ctx context.Context, req apigen.SetPluginConfigRequestObject) (apigen.SetPluginConfigResponseObject, error)
- func (s *Server) SetSourceHealthCheck(ctx context.Context, req apigen.SetSourceHealthCheckRequestObject) (apigen.SetSourceHealthCheckResponseObject, error)
- func (s *Server) SetSourceImageRetries(ctx context.Context, req apigen.SetSourceImageRetriesRequestObject) (apigen.SetSourceImageRetriesResponseObject, error)
- func (s *Server) SetSourceSettings(ctx context.Context, req apigen.SetSourceSettingsRequestObject) (apigen.SetSourceSettingsResponseObject, error)
- func (s *Server) SourceChapters(ctx context.Context, req apigen.SourceChaptersRequestObject) (apigen.SourceChaptersResponseObject, error)
- func (s *Server) SourceFilters(ctx context.Context, req apigen.SourceFiltersRequestObject) (apigen.SourceFiltersResponseObject, error)
- func (s *Server) SourceImage(ctx context.Context, req apigen.SourceImageRequestObject) (apigen.SourceImageResponseObject, error)
- func (s *Server) SourceLatest(ctx context.Context, req apigen.SourceLatestRequestObject) (apigen.SourceLatestResponseObject, error)
- func (s *Server) SourcePopular(ctx context.Context, req apigen.SourcePopularRequestObject) (apigen.SourcePopularResponseObject, error)
- func (s *Server) SourceSearch(ctx context.Context, req apigen.SourceSearchRequestObject) (apigen.SourceSearchResponseObject, error)
- func (s *Server) SourceSeries(ctx context.Context, req apigen.SourceSeriesRequestObject) (apigen.SourceSeriesResponseObject, error)
- func (s *Server) SyncPlugin(ctx context.Context, req apigen.SyncPluginRequestObject) (apigen.SyncPluginResponseObject, error)
- func (s *Server) TestMetaDuplicateJudge(ctx context.Context, req apigen.TestMetaDuplicateJudgeRequestObject) (apigen.TestMetaDuplicateJudgeResponseObject, error)
- func (s *Server) TestMetaSearchEngine(ctx context.Context, req apigen.TestMetaSearchEngineRequestObject) (apigen.TestMetaSearchEngineResponseObject, error)
- func (s *Server) TestProxy(ctx context.Context, req apigen.TestProxyRequestObject) (apigen.TestProxyResponseObject, error)
- func (s *Server) TestProxySettings(ctx context.Context, req apigen.TestProxySettingsRequestObject) (apigen.TestProxySettingsResponseObject, error)
- func (s *Server) TestSolver(ctx context.Context, req apigen.TestSolverRequestObject) (apigen.TestSolverResponseObject, error)
- func (s *Server) TestSolverSettings(ctx context.Context, req apigen.TestSolverSettingsRequestObject) (apigen.TestSolverSettingsResponseObject, error)
- func (s *Server) TestStorage(ctx context.Context, req apigen.TestStorageRequestObject) (apigen.TestStorageResponseObject, error)
- func (s *Server) UnassignNetworkProfile(ctx context.Context, req apigen.UnassignNetworkProfileRequestObject) (apigen.UnassignNetworkProfileResponseObject, error)
- func (s *Server) UninstallPackage(ctx context.Context, req apigen.UninstallPackageRequestObject) (apigen.UninstallPackageResponseObject, error)
- func (s *Server) UpdateMe(ctx context.Context, req apigen.UpdateMeRequestObject) (apigen.UpdateMeResponseObject, error)
- func (s *Server) UpdatePackage(ctx context.Context, req apigen.UpdatePackageRequestObject) (apigen.UpdatePackageResponseObject, error)
- func (s *Server) UpdatePlugin(ctx context.Context, req apigen.UpdatePluginRequestObject) (apigen.UpdatePluginResponseObject, error)
- func (s *Server) UpdateProxy(ctx context.Context, req apigen.UpdateProxyRequestObject) (apigen.UpdateProxyResponseObject, error)
- func (s *Server) UpdateQueueKind(ctx context.Context, req apigen.UpdateQueueKindRequestObject) (apigen.UpdateQueueKindResponseObject, error)
- func (s *Server) UpdateSolver(ctx context.Context, req apigen.UpdateSolverRequestObject) (apigen.UpdateSolverResponseObject, error)
- func (s *Server) UpdateSource(ctx context.Context, req apigen.UpdateSourceRequestObject) (apigen.UpdateSourceResponseObject, error)
- func (s *Server) UpdateStorage(ctx context.Context, req apigen.UpdateStorageRequestObject) (apigen.UpdateStorageResponseObject, error)
- func (s *Server) UpdateUser(ctx context.Context, req apigen.UpdateUserRequestObject) (apigen.UpdateUserResponseObject, error)
- func (s *Server) UpdateWorkSeries(ctx context.Context, req apigen.UpdateWorkSeriesRequestObject) (apigen.UpdateWorkSeriesResponseObject, error)
Constants ¶
const ( SessionCookie = "panelarr_session" CSRFCookie = "panelarr_csrf" CSRFHeader = "X-CSRF-Token" APIKeyHeader = "X-Api-Key" //nolint:gosec // a header name, not a credential )
Cookie and header names.
const ( AccessPublic = "public" AccessUser = "user" AccessAdmin = "admin" )
Access levels, from the spec's x-panelarr-access extension.
const ( CodeInvalidRequest = "invalid_request" CodeNotFound = "not_found" CodeMethodNotAllowed = "method_not_allowed" CodeInternal = "internal" )
Error codes shared by many endpoints. Feature code adds its own.
const BasePath = "/api/v1"
BasePath is where the REST API is served.
const RequestIDHeader = "X-Request-Id"
RequestIDHeader carries the request ID in requests and responses.
const StatusClientClosedRequest = 499
StatusClientClosedRequest answers a request whose client went away before it finished (as nginx's 499); the client never sees it, but the request log does.
Variables ¶
This section is empty.
Functions ¶
func NewHandler ¶
NewHandler builds the root HTTP handler.
Types ¶
type Check ¶
Check is one readiness dependency. A failing required check makes the server not ready (e.g. the database). A failing optional one only marks it degraded: the server keeps serving what it can (e.g. reading downloaded chapters while a connected service is down).
type Deps ¶
type Deps struct {
Log *slog.Logger
Metrics *metrics.Metrics // nil when metrics are off
// MetricsOnAPI serves /metrics on this handler, to callers holding the
// metrics:read scope.
MetricsOnAPI bool
// Checks are the readiness dependencies, e.g. the database.
Checks []Check
Auth *auth.Service
Users *users.Service
Meta *meta.Service
Images *imagecache.Cache
Plugins *plugins.Host
// Signer signs image links the server hands out.
Signer *imagecache.Signer
Jobs *jobs.Manager
Queue *queue.Queue
Hub *events.Hub
// Store answers list queries that need no service logic.
Store *store.Store
Library *library.Service
Chapters *chapters.Service
Reader *reader.Service
Downloads *downloads.Service
Storages *storage.Manager
Network *network.Service
// SecureCookies marks session cookies Secure (https deployments).
SecureCookies bool
// TrustedProxies may set X-Forwarded-For.
TrustedProxies []netip.Prefix
// Web serves the web app for every path nothing else answers (optional).
Web http.Handler
}
Deps are what the HTTP layer needs from the rest of the server.
type Problem ¶
type Problem struct {
Status int
Code string
Detail string
Fields []apigen.FieldError
// CurrentRunID goes with already_running.
CurrentRunID *uuid.UUID
// CurrentRun is a plugin job's running run (its own ID).
CurrentRun string
// WorkID, WorkTitle and ChapterLabel say which chapter a reader
// couldn't load (only when the caller may see it).
WorkID *uuid.UUID
WorkTitle string
ChapterLabel string
}
Problem is an error a handler returns to send a specific problem response. Any other error becomes a 500 without details.
func NewProblem ¶
NewProblem builds a Problem.
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server implements the generated strict API interface.
func (*Server) AcceptInvite ¶
func (s *Server) AcceptInvite(ctx context.Context, req apigen.AcceptInviteRequestObject) (apigen.AcceptInviteResponseObject, error)
AcceptInvite creates an account from an invite and signs it in.
func (*Server) AddFromSource ¶
func (s *Server) AddFromSource(ctx context.Context, req apigen.AddFromSourceRequestObject) (apigen.AddFromSourceResponseObject, error)
AddFromSource adds a series seen on a source, or offers entries to pick.
func (*Server) AddToLibrary ¶
func (s *Server) AddToLibrary(ctx context.Context, req apigen.AddToLibraryRequestObject) (apigen.AddToLibraryResponseObject, error)
AddToLibrary adds a catalogue entry to the caller's library.
func (*Server) AssignNetworkProfile ¶
func (s *Server) AssignNetworkProfile(ctx context.Context, req apigen.AssignNetworkProfileRequestObject) (apigen.AssignNetworkProfileResponseObject, error)
AssignNetworkProfile assigns a profile at a level.
func (*Server) AttachCandidate ¶
func (s *Server) AttachCandidate(ctx context.Context, req apigen.AttachCandidateRequestObject) (apigen.AttachCandidateResponseObject, error)
AttachCandidate attaches a candidate.
func (*Server) AttachSeries ¶
func (s *Server) AttachSeries(ctx context.Context, req apigen.AttachSeriesRequestObject) (apigen.AttachSeriesResponseObject, error)
AttachSeries attaches a series by source and key, or by URL.
func (*Server) BrowseCatalog ¶
func (s *Server) BrowseCatalog(ctx context.Context, req apigen.BrowseCatalogRequestObject) (apigen.BrowseCatalogResponseObject, error)
BrowseCatalog lists the catalogue.
func (*Server) CancelJobRun ¶
func (s *Server) CancelJobRun(ctx context.Context, req apigen.CancelJobRunRequestObject) (apigen.CancelJobRunResponseObject, error)
CancelJobRun cancels a running run.
func (*Server) CancelMetaJobRun ¶
func (s *Server) CancelMetaJobRun(ctx context.Context, req apigen.CancelMetaJobRunRequestObject) (apigen.CancelMetaJobRunResponseObject, error)
CancelMetaJobRun cancels a running meta job run.
func (*Server) CancelPluginJobRun ¶
func (s *Server) CancelPluginJobRun(ctx context.Context, req apigen.CancelPluginJobRunRequestObject) (apigen.CancelPluginJobRunResponseObject, error)
CancelPluginJobRun cancels a plugin job's running run.
func (*Server) CancelTask ¶
func (s *Server) CancelTask(ctx context.Context, req apigen.CancelTaskRequestObject) (apigen.CancelTaskResponseObject, error)
CancelTask cancels a task.
func (*Server) ChangeMyPassword ¶
func (s *Server) ChangeMyPassword(ctx context.Context, req apigen.ChangeMyPasswordRequestObject) (apigen.ChangeMyPasswordResponseObject, error)
ChangeMyPassword changes the caller's password.
func (*Server) CheckInvite ¶
func (s *Server) CheckInvite(ctx context.Context, req apigen.CheckInviteRequestObject) (apigen.CheckInviteResponseObject, error)
CheckInvite says whether an invite token is valid.
func (*Server) CheckMetaConnection ¶
func (s *Server) CheckMetaConnection(ctx context.Context, _ apigen.CheckMetaConnectionRequestObject) (apigen.CheckMetaConnectionResponseObject, error)
CheckMetaConnection checks the connection again now.
func (*Server) ClearMyHistory ¶
func (s *Server) ClearMyHistory(ctx context.Context, _ apigen.ClearMyHistoryRequestObject) (apigen.ClearMyHistoryResponseObject, error)
ClearMyHistory takes everything the caller read up to now out of their history.
func (*Server) ClearPackageImageRetries ¶
func (s *Server) ClearPackageImageRetries(ctx context.Context, req apigen.ClearPackageImageRetriesRequestObject) (apigen.ClearPackageImageRetriesResponseObject, error)
ClearPackageImageRetries removes a package's setting.
func (*Server) ClearSourceImageRetries ¶
func (s *Server) ClearSourceImageRetries(ctx context.Context, req apigen.ClearSourceImageRetriesRequestObject) (apigen.ClearSourceImageRetriesResponseObject, error)
ClearSourceImageRetries removes a source's own setting.
func (*Server) CompleteSetup ¶
func (s *Server) CompleteSetup(ctx context.Context, _ apigen.CompleteSetupRequestObject) (apigen.CompleteSetupResponseObject, error)
CompleteSetup finishes the wizard.
func (*Server) ConfirmMetaDuplicate ¶
func (s *Server) ConfirmMetaDuplicate(ctx context.Context, req apigen.ConfirmMetaDuplicateRequestObject) (apigen.ConfirmMetaDuplicateResponseObject, error)
ConfirmMetaDuplicate merges a pair.
func (*Server) CreateInvite ¶
func (s *Server) CreateInvite(ctx context.Context, req apigen.CreateInviteRequestObject) (apigen.CreateInviteResponseObject, error)
CreateInvite creates an invite.
func (*Server) CreateMyApiKey ¶
func (s *Server) CreateMyApiKey(ctx context.Context, req apigen.CreateMyApiKeyRequestObject) (apigen.CreateMyApiKeyResponseObject, error)
CreateMyApiKey creates an API key for the caller.
func (*Server) CreateNetworkProfile ¶
func (s *Server) CreateNetworkProfile(ctx context.Context, req apigen.CreateNetworkProfileRequestObject) (apigen.CreateNetworkProfileResponseObject, error)
CreateNetworkProfile adds a profile.
func (*Server) CreateProxy ¶
func (s *Server) CreateProxy(ctx context.Context, req apigen.CreateProxyRequestObject) (apigen.CreateProxyResponseObject, error)
CreateProxy adds a proxy.
func (*Server) CreateSetupAdmin ¶
func (s *Server) CreateSetupAdmin(ctx context.Context, req apigen.CreateSetupAdminRequestObject) (apigen.CreateSetupAdminResponseObject, error)
CreateSetupAdmin creates the first account and signs it in.
func (*Server) CreateSolver ¶
func (s *Server) CreateSolver(ctx context.Context, req apigen.CreateSolverRequestObject) (apigen.CreateSolverResponseObject, error)
CreateSolver adds a solver.
func (*Server) CreateStorage ¶
func (s *Server) CreateStorage(ctx context.Context, req apigen.CreateStorageRequestObject) (apigen.CreateStorageResponseObject, error)
CreateStorage adds a storage after checking it works.
func (*Server) CreateUser ¶
func (s *Server) CreateUser(ctx context.Context, req apigen.CreateUserRequestObject) (apigen.CreateUserResponseObject, error)
CreateUser creates a user with a password.
func (*Server) DeleteChapterFile ¶
func (s *Server) DeleteChapterFile(ctx context.Context, req apigen.DeleteChapterFileRequestObject) (apigen.DeleteChapterFileResponseObject, error)
DeleteChapterFile deletes a chapter's downloaded file.
func (*Server) DeleteInvite ¶
func (s *Server) DeleteInvite(ctx context.Context, req apigen.DeleteInviteRequestObject) (apigen.DeleteInviteResponseObject, error)
DeleteInvite revokes an invite.
func (*Server) DeleteMyApiKey ¶
func (s *Server) DeleteMyApiKey(ctx context.Context, req apigen.DeleteMyApiKeyRequestObject) (apigen.DeleteMyApiKeyResponseObject, error)
DeleteMyApiKey revokes one of the caller's API keys.
func (*Server) DeleteMySession ¶
func (s *Server) DeleteMySession(ctx context.Context, req apigen.DeleteMySessionRequestObject) (apigen.DeleteMySessionResponseObject, error)
DeleteMySession ends one of the caller's sessions.
func (*Server) DeleteNetworkProfile ¶
func (s *Server) DeleteNetworkProfile(ctx context.Context, req apigen.DeleteNetworkProfileRequestObject) (apigen.DeleteNetworkProfileResponseObject, error)
DeleteNetworkProfile removes a profile.
func (*Server) DeletePlugin ¶
func (s *Server) DeletePlugin(ctx context.Context, req apigen.DeletePluginRequestObject) (apigen.DeletePluginResponseObject, error)
DeletePlugin removes a plugin.
func (*Server) DeleteProxy ¶
func (s *Server) DeleteProxy(ctx context.Context, req apigen.DeleteProxyRequestObject) (apigen.DeleteProxyResponseObject, error)
DeleteProxy removes a proxy.
func (*Server) DeleteReaderSettings ¶
func (s *Server) DeleteReaderSettings(ctx context.Context, req apigen.DeleteReaderSettingsRequestObject) (apigen.DeleteReaderSettingsResponseObject, error)
DeleteReaderSettings removes one level of the caller's reader settings.
func (*Server) DeleteSolver ¶
func (s *Server) DeleteSolver(ctx context.Context, req apigen.DeleteSolverRequestObject) (apigen.DeleteSolverResponseObject, error)
DeleteSolver removes a solver.
func (*Server) DeleteStorage ¶
func (s *Server) DeleteStorage(ctx context.Context, req apigen.DeleteStorageRequestObject) (apigen.DeleteStorageResponseObject, error)
DeleteStorage removes an empty storage.
func (*Server) DeleteUser ¶
func (s *Server) DeleteUser(ctx context.Context, req apigen.DeleteUserRequestObject) (apigen.DeleteUserResponseObject, error)
DeleteUser deletes a user.
func (*Server) DetachSeries ¶
func (s *Server) DetachSeries(ctx context.Context, req apigen.DetachSeriesRequestObject) (apigen.DetachSeriesResponseObject, error)
DetachSeries rejects a series for the work.
func (*Server) DismissMetaDuplicate ¶
func (s *Server) DismissMetaDuplicate(ctx context.Context, req apigen.DismissMetaDuplicateRequestObject) (apigen.DismissMetaDuplicateResponseObject, error)
DismissMetaDuplicate marks a pair as different works.
func (*Server) DownloadChapters ¶
func (s *Server) DownloadChapters(ctx context.Context, req apigen.DownloadChaptersRequestObject) (apigen.DownloadChaptersResponseObject, error)
DownloadChapters queues downloads of a work's chapters.
func (*Server) GetCatalogEntry ¶
func (s *Server) GetCatalogEntry(ctx context.Context, req apigen.GetCatalogEntryRequestObject) (apigen.GetCatalogEntryResponseObject, error)
GetCatalogEntry returns one entry in full.
func (*Server) GetCatalogEntryCover ¶
func (s *Server) GetCatalogEntryCover(ctx context.Context, req apigen.GetCatalogEntryCoverRequestObject) (apigen.GetCatalogEntryCoverResponseObject, error)
GetCatalogEntryCover serves an entry's cover from the image cache.
func (*Server) GetChapterPage ¶
func (s *Server) GetChapterPage(ctx context.Context, req apigen.GetChapterPageRequestObject) (apigen.GetChapterPageResponseObject, error)
GetChapterPage serves one page image.
func (*Server) GetChapterPages ¶
func (s *Server) GetChapterPages(ctx context.Context, req apigen.GetChapterPagesRequestObject) (apigen.GetChapterPagesResponseObject, error)
GetChapterPages returns a chapter's pages for the reader.
func (*Server) GetJob ¶
func (s *Server) GetJob(ctx context.Context, req apigen.GetJobRequestObject) (apigen.GetJobResponseObject, error)
GetJob returns one job.
func (*Server) GetJobRun ¶
func (s *Server) GetJobRun(ctx context.Context, req apigen.GetJobRunRequestObject) (apigen.GetJobRunResponseObject, error)
GetJobRun returns one run in full.
func (*Server) GetMe ¶
func (s *Server) GetMe(ctx context.Context, _ apigen.GetMeRequestObject) (apigen.GetMeResponseObject, error)
GetMe returns the caller.
func (*Server) GetMetaConnection ¶
func (s *Server) GetMetaConnection(ctx context.Context, _ apigen.GetMetaConnectionRequestObject) (apigen.GetMetaConnectionResponseObject, error)
GetMetaConnection shows the connection and its state.
func (*Server) GetMetaDuplicate ¶
func (s *Server) GetMetaDuplicate(ctx context.Context, req apigen.GetMetaDuplicateRequestObject) (apigen.GetMetaDuplicateResponseObject, error)
GetMetaDuplicate returns one pair.
func (*Server) GetMetaDuplicateJudge ¶
func (s *Server) GetMetaDuplicateJudge(ctx context.Context, _ apigen.GetMetaDuplicateJudgeRequestObject) (apigen.GetMetaDuplicateJudgeResponseObject, error)
GetMetaDuplicateJudge returns the decision model settings.
func (*Server) GetMetaHealth ¶
func (s *Server) GetMetaHealth(ctx context.Context, _ apigen.GetMetaHealthRequestObject) (apigen.GetMetaHealthResponseObject, error)
GetMetaHealth returns meta's own health.
func (*Server) GetMetaJob ¶
func (s *Server) GetMetaJob(ctx context.Context, req apigen.GetMetaJobRequestObject) (apigen.GetMetaJobResponseObject, error)
GetMetaJob returns one of meta's jobs.
func (*Server) GetMetaJobRun ¶
func (s *Server) GetMetaJobRun(ctx context.Context, req apigen.GetMetaJobRunRequestObject) (apigen.GetMetaJobRunResponseObject, error)
GetMetaJobRun returns a meta job's run in full.
func (*Server) GetMetaNetwork ¶
func (s *Server) GetMetaNetwork(ctx context.Context, _ apigen.GetMetaNetworkRequestObject) (apigen.GetMetaNetworkResponseObject, error)
GetMetaNetwork shows each metadata provider's profile in force and what meta applies.
func (*Server) GetMetaSearchEngine ¶
func (s *Server) GetMetaSearchEngine(ctx context.Context, _ apigen.GetMetaSearchEngineRequestObject) (apigen.GetMetaSearchEngineResponseObject, error)
GetMetaSearchEngine returns meta's search engine settings and state.
func (*Server) GetMetaSyncRun ¶
func (s *Server) GetMetaSyncRun(ctx context.Context, req apigen.GetMetaSyncRunRequestObject) (apigen.GetMetaSyncRunResponseObject, error)
GetMetaSyncRun returns one sync run.
func (*Server) GetMyHistory ¶
func (s *Server) GetMyHistory(ctx context.Context, req apigen.GetMyHistoryRequestObject) (apigen.GetMyHistoryResponseObject, error)
GetMyHistory lists the chapters the caller read.
func (*Server) GetMyPreferences ¶
func (s *Server) GetMyPreferences(ctx context.Context, _ apigen.GetMyPreferencesRequestObject) (apigen.GetMyPreferencesResponseObject, error)
GetMyPreferences returns the caller's app preferences.
func (*Server) GetMyUpdates ¶
func (s *Server) GetMyUpdates(ctx context.Context, req apigen.GetMyUpdatesRequestObject) (apigen.GetMyUpdatesResponseObject, error)
GetMyUpdates lists the chapters that appeared in the caller's library.
func (*Server) GetMyUpdatesStatus ¶
func (s *Server) GetMyUpdatesStatus(ctx context.Context, _ apigen.GetMyUpdatesStatusRequestObject) (apigen.GetMyUpdatesStatusResponseObject, error)
GetMyUpdatesStatus says how the chapter checks of the caller's library stand.
func (*Server) GetNetworkProfile ¶
func (s *Server) GetNetworkProfile(ctx context.Context, req apigen.GetNetworkProfileRequestObject) (apigen.GetNetworkProfileResponseObject, error)
GetNetworkProfile returns a profile.
func (*Server) GetPackage ¶
func (s *Server) GetPackage(ctx context.Context, req apigen.GetPackageRequestObject) (apigen.GetPackageResponseObject, error)
GetPackage returns one of a plugin's packages.
func (*Server) GetPackageIcon ¶
func (s *Server) GetPackageIcon(ctx context.Context, req apigen.GetPackageIconRequestObject) (apigen.GetPackageIconResponseObject, error)
GetPackageIcon serves a package's icon through the server, cached.
func (*Server) GetPackageImageRetries ¶
func (s *Server) GetPackageImageRetries(ctx context.Context, req apigen.GetPackageImageRetriesRequestObject) (apigen.GetPackageImageRetriesResponseObject, error)
GetPackageImageRetries returns how a package's sources retry images.
func (*Server) GetPlugin ¶
func (s *Server) GetPlugin(ctx context.Context, req apigen.GetPluginRequestObject) (apigen.GetPluginResponseObject, error)
GetPlugin returns a plugin.
func (*Server) GetPluginConfig ¶
func (s *Server) GetPluginConfig(ctx context.Context, req apigen.GetPluginConfigRequestObject) (apigen.GetPluginConfigResponseObject, error)
GetPluginConfig returns a plugin's configuration.
func (*Server) GetPluginJob ¶
func (s *Server) GetPluginJob(ctx context.Context, req apigen.GetPluginJobRequestObject) (apigen.GetPluginJobResponseObject, error)
GetPluginJob returns one of a plugin's jobs.
func (*Server) GetPluginJobRun ¶
func (s *Server) GetPluginJobRun(ctx context.Context, req apigen.GetPluginJobRunRequestObject) (apigen.GetPluginJobRunResponseObject, error)
GetPluginJobRun returns a plugin job's run in full.
func (*Server) GetPluginNetwork ¶
func (s *Server) GetPluginNetwork(ctx context.Context, req apigen.GetPluginNetworkRequestObject) (apigen.GetPluginNetworkResponseObject, error)
GetPluginNetwork shows the profile in force for each of a plugin's sources.
func (*Server) GetProxy ¶
func (s *Server) GetProxy(ctx context.Context, req apigen.GetProxyRequestObject) (apigen.GetProxyResponseObject, error)
GetProxy returns a proxy.
func (*Server) GetQueue ¶
func (s *Server) GetQueue(ctx context.Context, _ apigen.GetQueueRequestObject) (apigen.GetQueueResponseObject, error)
GetQueue returns the queue per kind.
func (*Server) GetReaderSettings ¶
func (s *Server) GetReaderSettings(ctx context.Context, req apigen.GetReaderSettingsRequestObject) (apigen.GetReaderSettingsResponseObject, error)
GetReaderSettings returns the caller's reader settings for a place.
func (*Server) GetSetup ¶
func (s *Server) GetSetup(ctx context.Context, _ apigen.GetSetupRequestObject) (apigen.GetSetupResponseObject, error)
GetSetup reports the first-run wizard's state.
func (*Server) GetSolver ¶
func (s *Server) GetSolver(ctx context.Context, req apigen.GetSolverRequestObject) (apigen.GetSolverResponseObject, error)
GetSolver returns a solver.
func (*Server) GetSourceImageRetries ¶
func (s *Server) GetSourceImageRetries(ctx context.Context, req apigen.GetSourceImageRetriesRequestObject) (apigen.GetSourceImageRetriesResponseObject, error)
GetSourceImageRetries returns how a source retries images.
func (*Server) GetSourceNetwork ¶
func (s *Server) GetSourceNetwork(ctx context.Context, req apigen.GetSourceNetworkRequestObject) (apigen.GetSourceNetworkResponseObject, error)
GetSourceNetwork shows one source's profile and what its plugin applies.
func (*Server) GetSourceSettings ¶
func (s *Server) GetSourceSettings(ctx context.Context, req apigen.GetSourceSettingsRequestObject) (apigen.GetSourceSettingsResponseObject, error)
GetSourceSettings returns a source's own settings.
func (*Server) GetSystemHealth ¶
func (s *Server) GetSystemHealth(ctx context.Context, _ apigen.GetSystemHealthRequestObject) (apigen.GetSystemHealthResponseObject, error)
GetSystemHealth shows every component's health, with errors (admins).
func (*Server) GetSystemInfo ¶
func (s *Server) GetSystemInfo(ctx context.Context, _ apigen.GetSystemInfoRequestObject) (apigen.GetSystemInfoResponseObject, error)
GetSystemInfo identifies the server and says whether it needs setting up.
func (*Server) GetTask ¶
func (s *Server) GetTask(ctx context.Context, req apigen.GetTaskRequestObject) (apigen.GetTaskResponseObject, error)
GetTask returns a task.
func (*Server) GetUser ¶
func (s *Server) GetUser(ctx context.Context, req apigen.GetUserRequestObject) (apigen.GetUserResponseObject, error)
GetUser returns a user.
func (*Server) GetWork ¶
func (s *Server) GetWork(ctx context.Context, req apigen.GetWorkRequestObject) (apigen.GetWorkResponseObject, error)
GetWork returns a work with its matching per source.
func (*Server) GetWorkChapter ¶
func (s *Server) GetWorkChapter(ctx context.Context, req apigen.GetWorkChapterRequestObject) (apigen.GetWorkChapterResponseObject, error)
GetWorkChapter returns one chapter with its copies.
func (*Server) GetWorkCover ¶
func (s *Server) GetWorkCover(ctx context.Context, req apigen.GetWorkCoverRequestObject) (apigen.GetWorkCoverResponseObject, error)
GetWorkCover serves a work's cover from the image cache.
func (*Server) GetWorkProgress ¶
func (s *Server) GetWorkProgress(ctx context.Context, req apigen.GetWorkProgressRequestObject) (apigen.GetWorkProgressResponseObject, error)
GetWorkProgress returns the caller's progress in a work.
func (*Server) InstallPackage ¶
func (s *Server) InstallPackage(ctx context.Context, req apigen.InstallPackageRequestObject) (apigen.InstallPackageResponseObject, error)
InstallPackage queues installing a package.
func (*Server) ListBookmarks ¶
func (s *Server) ListBookmarks(ctx context.Context, req apigen.ListBookmarksRequestObject) (apigen.ListBookmarksResponseObject, error)
ListBookmarks lists the caller's bookmarked chapters of a work.
func (*Server) ListDownloads ¶
func (s *Server) ListDownloads(ctx context.Context, req apigen.ListDownloadsRequestObject) (apigen.ListDownloadsResponseObject, error)
ListDownloads lists downloads.
func (*Server) ListInvites ¶
func (s *Server) ListInvites(ctx context.Context, _ apigen.ListInvitesRequestObject) (apigen.ListInvitesResponseObject, error)
ListInvites lists open invites.
func (*Server) ListJobRuns ¶
func (s *Server) ListJobRuns(ctx context.Context, req apigen.ListJobRunsRequestObject) (apigen.ListJobRunsResponseObject, error)
ListJobRuns lists a job's runs.
func (*Server) ListJobs ¶
func (s *Server) ListJobs(ctx context.Context, _ apigen.ListJobsRequestObject) (apigen.ListJobsResponseObject, error)
ListJobs lists the background jobs.
func (*Server) ListLibrary ¶
func (s *Server) ListLibrary(ctx context.Context, req apigen.ListLibraryRequestObject) (apigen.ListLibraryResponseObject, error)
ListLibrary lists the caller's library.
func (*Server) ListMetaDuplicates ¶
func (s *Server) ListMetaDuplicates(ctx context.Context, req apigen.ListMetaDuplicatesRequestObject) (apigen.ListMetaDuplicatesResponseObject, error)
ListMetaDuplicates lists suspected duplicate pairs.
func (*Server) ListMetaJobRuns ¶
func (s *Server) ListMetaJobRuns(ctx context.Context, req apigen.ListMetaJobRunsRequestObject) (apigen.ListMetaJobRunsResponseObject, error)
ListMetaJobRuns lists a meta job's runs.
func (*Server) ListMetaJobs ¶
func (s *Server) ListMetaJobs(ctx context.Context, _ apigen.ListMetaJobsRequestObject) (apigen.ListMetaJobsResponseObject, error)
ListMetaJobs lists meta's jobs.
func (*Server) ListMetaProviders ¶
func (s *Server) ListMetaProviders(ctx context.Context, _ apigen.ListMetaProvidersRequestObject) (apigen.ListMetaProvidersResponseObject, error)
ListMetaProviders lists meta's providers.
func (*Server) ListMetaSyncRuns ¶
func (s *Server) ListMetaSyncRuns(ctx context.Context, req apigen.ListMetaSyncRunsRequestObject) (apigen.ListMetaSyncRunsResponseObject, error)
ListMetaSyncRuns lists provider sync runs.
func (*Server) ListMyApiKeys ¶
func (s *Server) ListMyApiKeys(ctx context.Context, _ apigen.ListMyApiKeysRequestObject) (apigen.ListMyApiKeysResponseObject, error)
ListMyApiKeys lists the caller's API keys.
func (*Server) ListMySessions ¶
func (s *Server) ListMySessions(ctx context.Context, _ apigen.ListMySessionsRequestObject) (apigen.ListMySessionsResponseObject, error)
ListMySessions lists the caller's sessions.
func (*Server) ListNetworkAssignments ¶
func (s *Server) ListNetworkAssignments(ctx context.Context, _ apigen.ListNetworkAssignmentsRequestObject) (apigen.ListNetworkAssignmentsResponseObject, error)
ListNetworkAssignments lists the assignments.
func (*Server) ListNetworkProfiles ¶
func (s *Server) ListNetworkProfiles(ctx context.Context, req apigen.ListNetworkProfilesRequestObject) (apigen.ListNetworkProfilesResponseObject, error)
ListNetworkProfiles lists profiles.
func (*Server) ListPackageOrigins ¶
func (s *Server) ListPackageOrigins(ctx context.Context, req apigen.ListPackageOriginsRequestObject) (apigen.ListPackageOriginsResponseObject, error)
ListPackageOrigins lists where a plugin's packages come from.
func (*Server) ListPackages ¶
func (s *Server) ListPackages(ctx context.Context, req apigen.ListPackagesRequestObject) (apigen.ListPackagesResponseObject, error)
ListPackages lists what a plugin offers and has installed.
func (*Server) ListPluginJobRuns ¶
func (s *Server) ListPluginJobRuns(ctx context.Context, req apigen.ListPluginJobRunsRequestObject) (apigen.ListPluginJobRunsResponseObject, error)
ListPluginJobRuns lists a plugin job's runs.
func (*Server) ListPluginJobs ¶
func (s *Server) ListPluginJobs(ctx context.Context, req apigen.ListPluginJobsRequestObject) (apigen.ListPluginJobsResponseObject, error)
ListPluginJobs lists a plugin's jobs.
func (*Server) ListPlugins ¶
func (s *Server) ListPlugins(ctx context.Context, _ apigen.ListPluginsRequestObject) (apigen.ListPluginsResponseObject, error)
ListPlugins lists the plugins.
func (*Server) ListProxies ¶
func (s *Server) ListProxies(ctx context.Context, req apigen.ListProxiesRequestObject) (apigen.ListProxiesResponseObject, error)
ListProxies lists the proxies.
func (*Server) ListSeriesChapters ¶
func (s *Server) ListSeriesChapters(ctx context.Context, req apigen.ListSeriesChaptersRequestObject) (apigen.ListSeriesChaptersResponseObject, error)
ListSeriesChapters lists one source's chapters of a work.
func (*Server) ListSolvers ¶
func (s *Server) ListSolvers(ctx context.Context, req apigen.ListSolversRequestObject) (apigen.ListSolversResponseObject, error)
ListSolvers lists the solvers.
func (*Server) ListSources ¶
func (s *Server) ListSources(ctx context.Context, req apigen.ListSourcesRequestObject) (apigen.ListSourcesResponseObject, error)
ListSources lists the sources (admins), filtered.
func (*Server) ListStorages ¶
func (s *Server) ListStorages(ctx context.Context, _ apigen.ListStoragesRequestObject) (apigen.ListStoragesResponseObject, error)
ListStorages lists the storages.
func (*Server) ListTasks ¶
func (s *Server) ListTasks(ctx context.Context, req apigen.ListTasksRequestObject) (apigen.ListTasksResponseObject, error)
ListTasks lists tasks, newest first.
func (*Server) ListUsers ¶
func (s *Server) ListUsers(ctx context.Context, req apigen.ListUsersRequestObject) (apigen.ListUsersResponseObject, error)
ListUsers lists users by username.
func (*Server) ListWorkChapters ¶
func (s *Server) ListWorkChapters(ctx context.Context, req apigen.ListWorkChaptersRequestObject) (apigen.ListWorkChaptersResponseObject, error)
ListWorkChapters lists a work's unified chapters.
func (*Server) Login ¶
func (s *Server) Login(ctx context.Context, req apigen.LoginRequestObject) (apigen.LoginResponseObject, error)
Login signs a user in with a password.
func (*Server) Logout ¶
func (s *Server) Logout(ctx context.Context, _ apigen.LogoutRequestObject) (apigen.LogoutResponseObject, error)
Logout ends the current session.
func (*Server) MarkChaptersRead ¶
func (s *Server) MarkChaptersRead(ctx context.Context, req apigen.MarkChaptersReadRequestObject) (apigen.MarkChaptersReadResponseObject, error)
MarkChaptersRead marks chapters read or unread.
func (*Server) MarkWorkSeen ¶
func (s *Server) MarkWorkSeen(ctx context.Context, req apigen.MarkWorkSeenRequestObject) (apigen.MarkWorkSeenResponseObject, error)
MarkWorkSeen clears the caller's "new" badges of a work.
func (*Server) MatchWork ¶
func (s *Server) MatchWork(ctx context.Context, req apigen.MatchWorkRequestObject) (apigen.MatchWorkResponseObject, error)
MatchWork queues matching of a work.
func (*Server) MoveStorage ¶
func (s *Server) MoveStorage(ctx context.Context, req apigen.MoveStorageRequestObject) (apigen.MoveStorageResponseObject, error)
MoveStorage queues moving every file to another storage.
func (*Server) PinChapterVariant ¶
func (s *Server) PinChapterVariant(ctx context.Context, req apigen.PinChapterVariantRequestObject) (apigen.PinChapterVariantResponseObject, error)
PinChapterVariant pins (or unpins) a chapter's copy.
func (*Server) PutMetaDuplicateJudge ¶
func (s *Server) PutMetaDuplicateJudge(ctx context.Context, req apigen.PutMetaDuplicateJudgeRequestObject) (apigen.PutMetaDuplicateJudgeResponseObject, error)
PutMetaDuplicateJudge saves the decision model settings.
func (*Server) PutMetaSearchEngine ¶
func (s *Server) PutMetaSearchEngine(ctx context.Context, req apigen.PutMetaSearchEngineRequestObject) (apigen.PutMetaSearchEngineResponseObject, error)
PutMetaSearchEngine saves meta's search engine settings.
func (*Server) PutMyPreferences ¶
func (s *Server) PutMyPreferences(ctx context.Context, req apigen.PutMyPreferencesRequestObject) (apigen.PutMyPreferencesResponseObject, error)
PutMyPreferences replaces the caller's app preferences.
func (*Server) PutReaderSettings ¶
func (s *Server) PutReaderSettings(ctx context.Context, req apigen.PutReaderSettingsRequestObject) (apigen.PutReaderSettingsResponseObject, error)
PutReaderSettings replaces one level of the caller's reader settings.
func (*Server) RefreshMetaEntry ¶
func (s *Server) RefreshMetaEntry(ctx context.Context, req apigen.RefreshMetaEntryRequestObject) (apigen.RefreshMetaEntryResponseObject, error)
RefreshMetaEntry asks an entry's providers for fresh data.
func (*Server) RefreshMyUpdates ¶
func (s *Server) RefreshMyUpdates(ctx context.Context, _ apigen.RefreshMyUpdatesRequestObject) (apigen.RefreshMyUpdatesResponseObject, error)
RefreshMyUpdates queues chapter checks of the caller's library.
func (*Server) RefreshPackageOrigin ¶
func (s *Server) RefreshPackageOrigin(ctx context.Context, req apigen.RefreshPackageOriginRequestObject) (apigen.RefreshPackageOriginResponseObject, error)
RefreshPackageOrigin refreshes one origin now.
func (*Server) RefreshWork ¶
func (s *Server) RefreshWork(ctx context.Context, req apigen.RefreshWorkRequestObject) (apigen.RefreshWorkResponseObject, error)
RefreshWork queues chapter checks of a work's series now.
func (*Server) RegisterPlugin ¶
func (s *Server) RegisterPlugin(ctx context.Context, req apigen.RegisterPluginRequestObject) (apigen.RegisterPluginResponseObject, error)
RegisterPlugin adds a plugin.
func (*Server) ReloadPackage ¶
func (s *Server) ReloadPackage(ctx context.Context, req apigen.ReloadPackageRequestObject) (apigen.ReloadPackageResponseObject, error)
ReloadPackage loads an installed package again.
func (*Server) RemoveFromLibrary ¶
func (s *Server) RemoveFromLibrary(ctx context.Context, req apigen.RemoveFromLibraryRequestObject) (apigen.RemoveFromLibraryResponseObject, error)
RemoveFromLibrary takes a work out of the caller's library.
func (*Server) RemoveFromMyHistory ¶
func (s *Server) RemoveFromMyHistory(ctx context.Context, req apigen.RemoveFromMyHistoryRequestObject) (apigen.RemoveFromMyHistoryResponseObject, error)
RemoveFromMyHistory takes a series out of the caller's history.
func (*Server) ReopenMetaDuplicate ¶
func (s *Server) ReopenMetaDuplicate(ctx context.Context, req apigen.ReopenMetaDuplicateRequestObject) (apigen.ReopenMetaDuplicateResponseObject, error)
ReopenMetaDuplicate takes back a dismissal.
func (*Server) ReplaceNetworkProfile ¶
func (s *Server) ReplaceNetworkProfile(ctx context.Context, req apigen.ReplaceNetworkProfileRequestObject) (apigen.ReplaceNetworkProfileResponseObject, error)
ReplaceNetworkProfile replaces a profile's settings.
func (*Server) ResetMetaDuplicateJudge ¶
func (s *Server) ResetMetaDuplicateJudge(ctx context.Context, _ apigen.ResetMetaDuplicateJudgeRequestObject) (apigen.ResetMetaDuplicateJudgeResponseObject, error)
ResetMetaDuplicateJudge goes back to meta's configured settings.
func (*Server) ResetMetaSearchEngine ¶
func (s *Server) ResetMetaSearchEngine(ctx context.Context, _ apigen.ResetMetaSearchEngineRequestObject) (apigen.ResetMetaSearchEngineResponseObject, error)
ResetMetaSearchEngine goes back to meta's configured search engine.
func (*Server) RetryTask ¶
func (s *Server) RetryTask(ctx context.Context, req apigen.RetryTaskRequestObject) (apigen.RetryTaskResponseObject, error)
RetryTask queues a failed or cancelled task again.
func (*Server) RunJob ¶
func (s *Server) RunJob(ctx context.Context, req apigen.RunJobRequestObject) (apigen.RunJobResponseObject, error)
RunJob starts a job now.
func (*Server) RunMetaJob ¶
func (s *Server) RunMetaJob(ctx context.Context, req apigen.RunMetaJobRequestObject) (apigen.RunMetaJobResponseObject, error)
RunMetaJob starts one of meta's jobs.
func (*Server) RunMetaProviderSync ¶
func (s *Server) RunMetaProviderSync(ctx context.Context, req apigen.RunMetaProviderSyncRequestObject) (apigen.RunMetaProviderSyncResponseObject, error)
RunMetaProviderSync starts a provider sync in the metadata service.
func (*Server) RunPluginJob ¶
func (s *Server) RunPluginJob(ctx context.Context, req apigen.RunPluginJobRequestObject) (apigen.RunPluginJobResponseObject, error)
RunPluginJob starts one of a plugin's jobs.
func (*Server) SearchCatalog ¶
func (s *Server) SearchCatalog(ctx context.Context, req apigen.SearchCatalogRequestObject) (apigen.SearchCatalogResponseObject, error)
SearchCatalog searches the catalogue.
func (*Server) SearchWorkSource ¶
func (s *Server) SearchWorkSource(ctx context.Context, req apigen.SearchWorkSourceRequestObject) (apigen.SearchWorkSourceResponseObject, error)
SearchWorkSource searches one of the work's sources to fix its match.
func (*Server) SetAutoDownload ¶
func (s *Server) SetAutoDownload(ctx context.Context, req apigen.SetAutoDownloadRequestObject) (apigen.SetAutoDownloadResponseObject, error)
SetAutoDownload turns automatic downloads of new chapters on or off.
func (*Server) SetBookmarks ¶
func (s *Server) SetBookmarks(ctx context.Context, req apigen.SetBookmarksRequestObject) (apigen.SetBookmarksResponseObject, error)
SetBookmarks bookmarks chapters or removes their bookmarks.
func (*Server) SetChapterProgress ¶
func (s *Server) SetChapterProgress(ctx context.Context, req apigen.SetChapterProgressRequestObject) (apigen.SetChapterProgressResponseObject, error)
SetChapterProgress saves where the caller is in a chapter.
func (*Server) SetMetaConnection ¶
func (s *Server) SetMetaConnection(ctx context.Context, req apigen.SetMetaConnectionRequestObject) (apigen.SetMetaConnectionResponseObject, error)
SetMetaConnection tests and saves the connection.
func (*Server) SetPackageImageRetries ¶
func (s *Server) SetPackageImageRetries(ctx context.Context, req apigen.SetPackageImageRetriesRequestObject) (apigen.SetPackageImageRetriesResponseObject, error)
SetPackageImageRetries sets how a package's sources retry images.
func (*Server) SetPackageLanguages ¶
func (s *Server) SetPackageLanguages(ctx context.Context, req apigen.SetPackageLanguagesRequestObject) (apigen.SetPackageLanguagesResponseObject, error)
SetPackageLanguages chooses a package's languages.
func (*Server) SetPluginConfig ¶
func (s *Server) SetPluginConfig(ctx context.Context, req apigen.SetPluginConfigRequestObject) (apigen.SetPluginConfigResponseObject, error)
SetPluginConfig replaces a plugin's configuration.
func (*Server) SetSourceHealthCheck ¶
func (s *Server) SetSourceHealthCheck(ctx context.Context, req apigen.SetSourceHealthCheckRequestObject) (apigen.SetSourceHealthCheckResponseObject, error)
SetSourceHealthCheck turns a source's scheduled health checks on or off.
func (*Server) SetSourceImageRetries ¶
func (s *Server) SetSourceImageRetries(ctx context.Context, req apigen.SetSourceImageRetriesRequestObject) (apigen.SetSourceImageRetriesResponseObject, error)
SetSourceImageRetries sets a source's own setting.
func (*Server) SetSourceSettings ¶
func (s *Server) SetSourceSettings(ctx context.Context, req apigen.SetSourceSettingsRequestObject) (apigen.SetSourceSettingsResponseObject, error)
SetSourceSettings changes some of a source's settings.
func (*Server) SourceChapters ¶
func (s *Server) SourceChapters(ctx context.Context, req apigen.SourceChaptersRequestObject) (apigen.SourceChaptersResponseObject, error)
SourceChapters lists a series' chapters.
func (*Server) SourceFilters ¶
func (s *Server) SourceFilters(ctx context.Context, req apigen.SourceFiltersRequestObject) (apigen.SourceFiltersResponseObject, error)
SourceFilters returns a source's filters in the contract's JSON form.
func (*Server) SourceImage ¶
func (s *Server) SourceImage(ctx context.Context, req apigen.SourceImageRequestObject) (apigen.SourceImageResponseObject, error)
SourceImage serves a signed image of a source, fetched through its plugin and cached.
func (*Server) SourceLatest ¶
func (s *Server) SourceLatest(ctx context.Context, req apigen.SourceLatestRequestObject) (apigen.SourceLatestResponseObject, error)
SourceLatest lists a source's latest updates.
func (*Server) SourcePopular ¶
func (s *Server) SourcePopular(ctx context.Context, req apigen.SourcePopularRequestObject) (apigen.SourcePopularResponseObject, error)
SourcePopular lists a source's popular series.
func (*Server) SourceSearch ¶
func (s *Server) SourceSearch(ctx context.Context, req apigen.SourceSearchRequestObject) (apigen.SourceSearchResponseObject, error)
SourceSearch searches a source.
func (*Server) SourceSeries ¶
func (s *Server) SourceSeries(ctx context.Context, req apigen.SourceSeriesRequestObject) (apigen.SourceSeriesResponseObject, error)
SourceSeries returns a series' details.
func (*Server) SyncPlugin ¶
func (s *Server) SyncPlugin(ctx context.Context, req apigen.SyncPluginRequestObject) (apigen.SyncPluginResponseObject, error)
SyncPlugin refreshes a plugin now.
func (*Server) TestMetaDuplicateJudge ¶
func (s *Server) TestMetaDuplicateJudge(ctx context.Context, req apigen.TestMetaDuplicateJudgeRequestObject) (apigen.TestMetaDuplicateJudgeResponseObject, error)
TestMetaDuplicateJudge tries decision model settings.
func (*Server) TestMetaSearchEngine ¶
func (s *Server) TestMetaSearchEngine(ctx context.Context, req apigen.TestMetaSearchEngineRequestObject) (apigen.TestMetaSearchEngineResponseObject, error)
TestMetaSearchEngine tries search engine settings.
func (*Server) TestProxy ¶
func (s *Server) TestProxy(ctx context.Context, req apigen.TestProxyRequestObject) (apigen.TestProxyResponseObject, error)
TestProxy checks a saved proxy.
func (*Server) TestProxySettings ¶
func (s *Server) TestProxySettings(ctx context.Context, req apigen.TestProxySettingsRequestObject) (apigen.TestProxySettingsResponseObject, error)
TestProxySettings checks an unsaved proxy (or a saved one with changes).
func (*Server) TestSolver ¶
func (s *Server) TestSolver(ctx context.Context, req apigen.TestSolverRequestObject) (apigen.TestSolverResponseObject, error)
TestSolver checks a saved solver.
func (*Server) TestSolverSettings ¶
func (s *Server) TestSolverSettings(ctx context.Context, req apigen.TestSolverSettingsRequestObject) (apigen.TestSolverSettingsResponseObject, error)
TestSolverSettings checks an unsaved solver.
func (*Server) TestStorage ¶
func (s *Server) TestStorage(ctx context.Context, req apigen.TestStorageRequestObject) (apigen.TestStorageResponseObject, error)
TestStorage checks a storage now.
func (*Server) UnassignNetworkProfile ¶
func (s *Server) UnassignNetworkProfile(ctx context.Context, req apigen.UnassignNetworkProfileRequestObject) (apigen.UnassignNetworkProfileResponseObject, error)
UnassignNetworkProfile removes an assignment.
func (*Server) UninstallPackage ¶
func (s *Server) UninstallPackage(ctx context.Context, req apigen.UninstallPackageRequestObject) (apigen.UninstallPackageResponseObject, error)
UninstallPackage queues uninstalling a package.
func (*Server) UpdateMe ¶
func (s *Server) UpdateMe(ctx context.Context, req apigen.UpdateMeRequestObject) (apigen.UpdateMeResponseObject, error)
UpdateMe changes the caller's profile.
func (*Server) UpdatePackage ¶
func (s *Server) UpdatePackage(ctx context.Context, req apigen.UpdatePackageRequestObject) (apigen.UpdatePackageResponseObject, error)
UpdatePackage queues updating a package.
func (*Server) UpdatePlugin ¶
func (s *Server) UpdatePlugin(ctx context.Context, req apigen.UpdatePluginRequestObject) (apigen.UpdatePluginResponseObject, error)
UpdatePlugin changes a plugin.
func (*Server) UpdateProxy ¶
func (s *Server) UpdateProxy(ctx context.Context, req apigen.UpdateProxyRequestObject) (apigen.UpdateProxyResponseObject, error)
UpdateProxy changes a proxy.
func (*Server) UpdateQueueKind ¶
func (s *Server) UpdateQueueKind(ctx context.Context, req apigen.UpdateQueueKindRequestObject) (apigen.UpdateQueueKindResponseObject, error)
UpdateQueueKind pauses or resumes a kind.
func (*Server) UpdateSolver ¶
func (s *Server) UpdateSolver(ctx context.Context, req apigen.UpdateSolverRequestObject) (apigen.UpdateSolverResponseObject, error)
UpdateSolver changes a solver.
func (*Server) UpdateSource ¶
func (s *Server) UpdateSource(ctx context.Context, req apigen.UpdateSourceRequestObject) (apigen.UpdateSourceResponseObject, error)
UpdateSource turns a source on or off.
func (*Server) UpdateStorage ¶
func (s *Server) UpdateStorage(ctx context.Context, req apigen.UpdateStorageRequestObject) (apigen.UpdateStorageResponseObject, error)
UpdateStorage changes a storage or makes it the default.
func (*Server) UpdateUser ¶
func (s *Server) UpdateUser(ctx context.Context, req apigen.UpdateUserRequestObject) (apigen.UpdateUserResponseObject, error)
UpdateUser changes a user.
func (*Server) UpdateWorkSeries ¶
func (s *Server) UpdateWorkSeries(ctx context.Context, req apigen.UpdateWorkSeriesRequestObject) (apigen.UpdateWorkSeriesResponseObject, error)
UpdateWorkSeries sets a series' priority.
Source Files
¶
- authn.go
- convert.go
- errors.go
- events.go
- handlers_auth.go
- handlers_catalog.go
- handlers_chapters.go
- handlers_downloads.go
- handlers_image_retries.go
- handlers_jobs.go
- handlers_library.go
- handlers_me.go
- handlers_meta.go
- handlers_meta_admin.go
- handlers_meta_duplicates.go
- handlers_meta_jobs.go
- handlers_meta_search.go
- handlers_network.go
- handlers_plugin_jobs.go
- handlers_plugins.go
- handlers_reader.go
- handlers_setup.go
- handlers_sources.go
- handlers_system.go
- handlers_updates.go
- handlers_users.go
- health.go
- middleware.go
- policy.go
- problem.go
- server.go
- throttle.go