Documentation ¶
Overview ¶
Code generated by rice embed-go; DO NOT EDIT.
Index ¶
- type Comp
- type Response
- type Server
- func (server *Server) AppendTag(c *gin.Context)
- func (server *Server) CreateUser(c *gin.Context)
- func (server *Server) DeleteComposer(c *gin.Context)
- func (server *Server) DeleteSheet(c *gin.Context)
- func (server *Server) DeleteTag(c *gin.Context)
- func (server *Server) DeleteUser(c *gin.Context)
- func (server *Server) FindSheetsByTag(c *gin.Context)
- func (server *Server) GetComposersPage(c *gin.Context)
- func (server *Server) GetPDF(c *gin.Context)
- func (server *Server) GetSheet(c *gin.Context)
- func (server *Server) GetSheetsPage(c *gin.Context)
- func (server *Server) GetThumbnail(c *gin.Context)
- func (server *Server) GetUser(c *gin.Context)
- func (server *Server) GetUsers(c *gin.Context)
- func (server *Server) Home(c *gin.Context)
- func (server *Server) Initialize()
- func (server *Server) Login(c *gin.Context)
- func (server *Server) RequestPasswordReset(c *gin.Context)
- func (server *Server) ResetPassword(c *gin.Context)
- func (server *Server) Run(addr string, dev bool)
- func (server *Server) SearchComposers(c *gin.Context)
- func (server *Server) SearchSheets(c *gin.Context)
- func (server *Server) ServePortraits(c *gin.Context)
- func (server *Server) SetupRouter()
- func (server *Server) SignIn(email, password string) (string, error)
- func (server *Server) UpdateComposer(c *gin.Context)
- func (server *Server) UpdateSheet(c *gin.Context)
- func (server *Server) UpdateSheetInformationText(c *gin.Context)
- func (server *Server) UpdateUser(c *gin.Context)
- func (server *Server) UploadFile(c *gin.Context)
- func (server *Server) Version(c *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Server ¶
func (*Server) CreateUser ¶
func (*Server) DeleteComposer ¶
func (*Server) DeleteSheet ¶
Has to be safeName of the sheet
func (*Server) DeleteUser ¶
func (*Server) FindSheetsByTag ¶
func (*Server) GetComposersPage ¶
This endpoint will return all composers in Page like style. Meaning POST request will have 3 attributes:
- sort_by: (how is it sorted)
- page: (what page)
- limit: (limit number)
Return:
- composers: [...]
- page_max: [7] // How many pages there are
- page_current: [1] // Which page is currently selected
func (*Server) GetPDF ¶
Serve the PDF file Example request:
GET /sheet/pdf/Frédéric Chopin/Étude N. 1
sheetname and composer name have to be the safeName of them
func (*Server) GetSheet ¶
Get PDF file and information about an individual sheet. Example request:
GET /sheet/Étude N. 1
Has to be safeName
func (*Server) GetSheetsPage ¶
This endpoint will return all sheets in Page like style. Meaning POST request will have 3 attributes:
- sort_by: (how is it sorted)
- page: (what page)
- limit: (limit number)
- composer: (what composer)
Return:
- sheets: [...]
- page_max: [7] // How many pages there are
- page_current: [1] // Which page is currently selected
func (*Server) GetThumbnail ¶
Serve the thumbnail file name = safename of sheet
func (*Server) Initialize ¶
func (server *Server) Initialize()
func (*Server) RequestPasswordReset ¶
func (*Server) ResetPassword ¶
func (*Server) SearchComposers ¶
func (*Server) SearchSheets ¶
func (*Server) ServePortraits ¶
Serve the Composer Portraits Example request:
GET /composer/portrait/Chopin
func (*Server) SetupRouter ¶
func (server *Server) SetupRouter()
func (*Server) UpdateComposer ¶
Update a composer via PUT request body - formdata example:
- name: Chopin
- portrait_url: url
- epoch: romance