api

package
v0.0.0-...-6079cd8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 19, 2021 License: AGPL-3.0 Imports: 18 Imported by: 0

Documentation

Overview

movies

series

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddAllRoutes

func AddAllRoutes(rg *gin.RouterGroup)

func AddMoviesRoutes

func AddMoviesRoutes(routermovies *gin.RouterGroup)

func AddSeriesRoutes

func AddSeriesRoutes(routerseries *gin.RouterGroup)

func ApiAuth

func ApiAuth(c *gin.Context) int

func ApiConfigAll

func ApiConfigAll(ctx *gin.Context)

@Summary Get Complete Config @Description Get All Config Parameters @Tags config @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {object} map[string]interface{} @Failure 401 {object} string @Router /api/config/all [get]

func ApiConfigClear

func ApiConfigClear(ctx *gin.Context)

@Summary Clear Config @Description Clears the configuration and sets some examples @Tags config @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {object} map[string]interface{} @Failure 401 {object} string @Router /api/config/clear [delete]

func ApiConfigDelete

func ApiConfigDelete(ctx *gin.Context)

@Summary Delete Config @Description Deletes a configuration @Tags config @Accept json @Produce json @Param name path string true "Type Name: ex. quality_SD" @Param apikey query string true "apikey" @Success 200 {object} map[string]interface{} @Failure 401 {object} string @Router /api/config/delete/{name} [delete]

func ApiConfigGet

func ApiConfigGet(ctx *gin.Context)

@Summary Get Config @Description Gets a configuration @Tags config @Accept json @Produce json @Param name path string true "Type Name: ex. quality_SD" @Param apikey query string true "apikey" @Success 200 {object} interface{} @Failure 401 {object} string @Router /api/config/get/{name} [get]

func ApiConfigRefreshFile

func ApiConfigRefreshFile(ctx *gin.Context)

@Summary Reload ConfigFile @Description Refreshes the config from the file @Tags config @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {object} map[string]interface{} @Failure 401 {object} string @Router /api/config/refresh [get]

func ApiConfigUpdate

func ApiConfigUpdate(ctx *gin.Context)

@Summary Update Config @Description Updates a configuration @Tags config @Accept json @Produce json @Param config body interface{} true "Config" @Param name path string true "Type Name: ex. quality_SD" @Param apikey query string true "apikey" @Success 200 {object} map[string]interface{} @Failure 400 {object} string @Failure 401 {object} string @Router /api/config/update/{name} [post]

func ApiDbBackup

func ApiDbBackup(ctx *gin.Context)

@Summary Backup DB @Description Saves DB @Tags database @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/db/backup [get]

func ApiDbClear

func ApiDbClear(ctx *gin.Context)

@Summary Clear DB Table @Description Clears a DB Table @Tags database @Accept json @Produce json @Param name path string true "Table Name" @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/db/clear/{name} [delete]

func ApiDbClose

func ApiDbClose(ctx *gin.Context)

@Summary Close DB @Description Closes all database connections @Tags database @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/db/close [get]

func ApiDbIntegrity

func ApiDbIntegrity(ctx *gin.Context)

@Summary Integrity DB @Description Integrity Check DB @Tags database @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/db/integrity [get]

func ApiDbRemoveOldJobs

func ApiDbRemoveOldJobs(ctx *gin.Context)

@Summary Clean Old Jobs @Description Removes Jobs started over x days ago from db @Tags database @Accept json @Produce json @Param apikey query string true "apikey" @Param days query int true "Days ago" @Success 200 {string} string @Failure 401 {object} string @Router /api/db/oldjobs [delete]

func ApiDbVacuum

func ApiDbVacuum(ctx *gin.Context)

@Summary Vacuum DB @Description Vacuum database @Tags database @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/db/vacuum [get]

func ApiFillImdb

func ApiFillImdb(ctx *gin.Context)

@Summary Generate IMDB Cache @Description Downloads IMDB Dataset and creates a new database from it @Tags general @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/fillimdb [get]

func ApiGetQualities

func ApiGetQualities(ctx *gin.Context)

@Summary List Qualities @Description List Qualities with regex filters @Tags quality @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {array} database.Qualities @Failure 401 {object} string @Router /api/quality [get]

func ApiListConfigType

func ApiListConfigType(ctx *gin.Context)

@Summary List Config Type @Description List configurations of type @Tags config @Accept json @Produce json @Param type path string true "Type Name: ex. quality" @Param apikey query string true "apikey" @Success 200 {object} map[string]interface{} @Failure 401 {object} string @Router /api/config/type/{type} [get]

func ApiListQualityPriorities

func ApiListQualityPriorities(ctx *gin.Context)

@Summary List Quality Priorities @Description List allowed qualities and their priorities @Tags quality @Accept json @Produce json @Param name path string true "Quality Name: ex. quality_SD" @Param config path string true "Config Name: ex. movie_EN or serie_EN" @Param apikey query string true "apikey" @Success 200 {array} utils.ParseInfo @Failure 401 {object} string @Failure 404 {object} string @Router /api/quality/{name}/{config} [get]

func ApiMovieDelete

func ApiMovieDelete(ctx *gin.Context)

@Summary Delete Movies @Description Deletes Movies from all lists @Tags movie @Accept json @Produce json @Param id path int true "Movie ID: ex. 1" @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/movies/{id} [delete]

func ApiMovieDeleteList

func ApiMovieDeleteList(ctx *gin.Context)

@Summary Delete a Movie (List) @Description Deletes a Movie from a list @Tags movie @Accept json @Produce json @Param id path int true "Movie ID: ex. 1" @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/movies/list/{id} [delete]

func ApiMovieList

func ApiMovieList(ctx *gin.Context)

@Summary List Movies @Description List Movies @Tags movie @Accept json @Produce json @Param apikey query string true "apikey" @Param limit query int false "Limit" @Param page query int false "Page" @Param order query string false "Order By" @Success 200 {array} database.DbmovieJson @Failure 401 {object} string @Router /api/movies [get]

func ApiMovieListGet

func ApiMovieListGet(ctx *gin.Context)

@Summary List Movies (List) @Description Lists Movies from a list @Tags movie @Accept json @Produce json @Param name path string true "List Name: ex. EN" @Param limit query int false "Limit" @Param page query int false "Page" @Param order query string false "Order By" @Param apikey query string true "apikey" @Success 200 {array} database.ResultMoviesJson @Failure 401 {object} string @Router /api/movies/list/{name} [get]

func ApiMovieListUnmatched

func ApiMovieListUnmatched(ctx *gin.Context)

@Summary List Unmatched Movies @Description List Unmatched Movies @Tags movie @Accept json @Produce json @Param apikey query string true "apikey" @Param limit query int false "Limit" @Param page query int false "Page" @Param order query string false "Order By" @Success 200 {array} database.MovieFileUnmatchedJson @Failure 401 {object} string @Router /api/movies/unmatched [get]

func ApiNamingGenerate

func ApiNamingGenerate(ctx *gin.Context)

@Summary Name Generation Test @Description Test your Naming Convention @Tags general @Accept json @Produce json @Param config body ApiNameInputJson true "Config" @Param apikey query string true "apikey" @Success 200 {object} string @Failure 400 {object} string @Failure 401 {object} string @Router /api/naming [post]

func ApiParseFile

func ApiParseFile(ctx *gin.Context)

@Summary Parse a file @Description Parses a file for testing @Tags parse @Accept json @Produce json @Param toparse body apiparse true "To Parse" @Param apikey query string true "apikey" @Success 200 {object} utils.ParseInfo @Failure 400 {object} string @Failure 401 {object} string @Router /api/parse/file [post]

func ApiParseString

func ApiParseString(ctx *gin.Context)

@Summary Parse a string @Description Parses a string for testing @Tags parse @Accept json @Produce json @Param toparse body apiparse true "To Parse" @Param apikey query string true "apikey" @Success 200 {object} utils.ParseInfo @Failure 400 {object} string @Failure 401 {object} string @Router /api/parse/string [post]

func ApiQualityDelete

func ApiQualityDelete(ctx *gin.Context)

@Summary Delete Quality @Description Deletes a quality @Tags quality @Accept json @Produce json @Param id path string true "Id of Quality to delete" @Param apikey query string true "apikey" @Success 200 {array} database.Qualities @Failure 401 {object} string @Router /api/quality/{id} [delete]

func ApiQualityUpdate

func ApiQualityUpdate(ctx *gin.Context)

@Summary Update Quality @Description Updates or adds a quality @Tags quality @Accept json @Produce json @Param quality body database.Qualities true "Quality" @Param apikey query string true "apikey" @Success 200 {array} database.Qualities @Failure 400 {object} string @Failure 401 {object} string @Router /api/quality [post]

func ApiQueueList

func ApiQueueList(ctx *gin.Context)

@Summary Queue @Description Lists Queued and Started Jobs (but not finished) @Tags general @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {object} map[string]tasks.Job @Failure 401 {object} string @Router /api/queue [get]

func ApiQueueListStarted

func ApiQueueListStarted(ctx *gin.Context)

@Summary Queue History @Description Lists Started Jobs and finished but not queued jobs @Tags general @Accept json @Produce json @Param limit query int false "Limit" @Param page query int false "Page" @Param order query string false "Order By" @Param apikey query string true "apikey" @Success 200 {array} database.JobHistoryJson @Failure 401 {object} string @Router /api/queue/history [get]

func ApiSchedulerList

func ApiSchedulerList(ctx *gin.Context)

@Summary Scheduler Jobs @Description Lists Planned Jobs @Tags scheduler @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {object} string @Failure 401 {object} string @Router /api/scheduler/list [get]

func ApiSchedulerStart

func ApiSchedulerStart(c *gin.Context)

@Summary Start Scheduler @Description Start all Schedulers @Tags scheduler @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/scheduler/start [get]

func ApiSchedulerStop

func ApiSchedulerStop(c *gin.Context)

@Summary Stop Scheduler @Description Stops all Schedulers @Tags scheduler @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/scheduler/stop [get]

func ApiSeriesDelete

func ApiSeriesDelete(ctx *gin.Context)

@Summary Delete Series @Description Delete Series @Tags series @Accept json @Produce json @Param id path int true "Series ID" @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/series/{id} [delete]

func ApiSeriesEpisodesDelete

func ApiSeriesEpisodesDelete(ctx *gin.Context)

@Summary Delete Episode @Description Delete Series Episode @Tags series @Accept json @Produce json @Param id path int true "Episode ID" @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/series/episodes/{id} [delete]

func ApiSeriesEpisodesGet

func ApiSeriesEpisodesGet(ctx *gin.Context)

@Summary List Series Episodes @Description List episodes @Tags series @Accept json @Produce json @Param limit query int false "Limit" @Param page query int false "Page" @Param order query string false "Order By" @Param apikey query string true "apikey" @Success 200 {array} database.DbserieEpisodeJson @Failure 401 {object} string @Router /api/series/episodes [get]

func ApiSeriesEpisodesGetSingle

func ApiSeriesEpisodesGetSingle(ctx *gin.Context)

@Summary List Series Episodes (Single) @Description List episodes @Tags series @Accept json @Produce json @Param id path int true "Series ID" @Param limit query int false "Limit" @Param page query int false "Page" @Param order query string false "Order By" @Param apikey query string true "apikey" @Success 200 {array} database.DbserieEpisodeJson @Failure 401 {object} string @Router /api/series/episodes/{id} [get]

func ApiSeriesEpisodesListDelete

func ApiSeriesEpisodesListDelete(ctx *gin.Context)

@Summary Delete Episode (List) @Description Delete Series Episode @Tags series @Accept json @Produce json @Param id path int true "Episode ID" @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/series/episodes/list/{id} [delete]

func ApiSeriesEpisodesListGet

func ApiSeriesEpisodesListGet(ctx *gin.Context)

@Summary List Series Episodes (List) @Description List episodes @Tags series @Accept json @Produce json @Param id path int true "Series ID" @Param limit query int false "Limit" @Param page query int false "Page" @Param order query string false "Order By" @Param apikey query string true "apikey" @Success 200 {array} database.ResultSerieEpisodesJson @Failure 401 {object} string @Router /api/series/episodes/list/{id} [get]

func ApiSeriesGet

func ApiSeriesGet(ctx *gin.Context)

@Summary List Series @Description List Series @Tags series @Accept json @Produce json @Param limit query int false "Limit" @Param page query int false "Page" @Param order query string false "Order By" @Param apikey query string true "apikey" @Success 200 {array} database.Dbserie @Failure 401 {object} string @Router /api/series [get]

func ApiSeriesListDelete

func ApiSeriesListDelete(ctx *gin.Context)

@Summary Delete Series (List) @Description Delete Series @Tags series @Accept json @Produce json @Param id path int true "Series ID" @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/series/list/{id} [delete]

func ApiSeriesListGet

func ApiSeriesListGet(ctx *gin.Context)

@Summary List Series (List) @Description List Series @Tags series @Accept json @Produce json @Param name path string true "List Name" @Param limit query int false "Limit" @Param page query int false "Page" @Param order query string false "Order By" @Param apikey query string true "apikey" @Success 200 {array} database.ResultSeries @Failure 401 {object} string @Router /api/series/{name} [get]

func ApiSeriesUnmatched

func ApiSeriesUnmatched(ctx *gin.Context)

@Summary List Series Unmatched @Description List Unmatched episodes @Tags series @Accept json @Produce json @Param limit query int false "Limit" @Param page query int false "Page" @Param order query string false "Order By" @Param apikey query string true "apikey" @Success 200 {array} database.SerieFileUnmatchedJson @Failure 401 {object} string @Router /api/series/unmatched [get]

func ApiStructure

func ApiStructure(ctx *gin.Context)

@Summary Structure Single Item @Description Structure a single folder @Tags general @Accept json @Produce json @Param config body ApiStructureJson true "Config" @Param apikey query string true "apikey" @Success 200 {object} string @Failure 400 {object} string @Failure 401 {object} string @Router /api/structure [post]

func ApiTraktGetAuthUrl

func ApiTraktGetAuthUrl(ctx *gin.Context)

@Summary Trakt Auhtorize @Description List Qualities with regex filters @Tags general @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/trakt/authorize [get]

func ApiTraktGetStoreToken

func ApiTraktGetStoreToken(ctx *gin.Context)

@Summary Trakt Save Token @Description Saves Trakt token after Authorization @Tags general @Accept json @Produce json @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/trakt/token/{code} [get]

func ApiTraktGetUserList

func ApiTraktGetUserList(ctx *gin.Context)

@Summary Trakt Get List (Auth Test) @Description Get User List @Tags general @Accept json @Produce json @Param user path string true "Trakt Username" @Param list path string true "List Name" @Param apikey query string true "apikey" @Success 200 {string} string @Failure 401 {object} string @Router /api/trakt/user/{user}/{list} [get]

Types

type ApiNameInput

type ApiNameInput struct {
	Cfg_Media string `json:"cfg_media"`
	GroupType string `json:"grouptype"`
	FilePath  string `json:"filepath"`
	MovieID   int    `json:"movieid"`
	SerieID   int    `json:"serieid"`
}

type ApiNameInputJson

type ApiNameInputJson struct {
	Cfg_Media string `json:"cfg_media"`
	GroupType string `json:"grouptype"`
	FilePath  string `json:"filepath"`
	MovieID   int    `json:"movieid"`
	SerieID   int    `json:"serieid"`
}

type ApiStructureJson

type ApiStructureJson struct {
	Folder                     string
	Disableruntimecheck        bool
	Disabledisallowed          bool
	Disabledeletewronglanguage bool
	Grouptype                  string
	Sourcepathtemplate         string
	Targetpathtemplate         string
	Configentry                string
	Forceid                    int
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL