Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateNewNote ¶
CreateNewNote godoc @Summary Create Note @Description creates a new note @Tags notes @Accept json @Produce json @Param req body models.NoteRequest true "Note Request" @Success 200 {object} models.Response @Failure 400 {object} models.Response @Router /notes [post] @Security ApiKeyAuth
func DeleteNote ¶
DeleteNote godoc @Summary Delete a note @Description deletes note by id @Tags notes @Accept json @Produce json @Param id path string true "Note ID" @Success 200 {object} models.Response @Failure 400 {object} models.Response @Router /notes/{id} [delete] @Security ApiKeyAuth
func GetNotes ¶
GetNotes godoc @Summary Get Notes @Description gets user notes with pagination @Tags notes @Accept json @Produce json @Param page query string false "Switch page by 'page'" @Success 200 {object} models.Response @Failure 400 {object} models.Response @Router /notes [get] @Security ApiKeyAuth
func GetOneNote ¶
GetOneNote godoc @Summary Get a note @Description get note by id @Tags notes @Accept json @Produce json @Param id path string true "Note ID" @Success 200 {object} models.Response @Failure 400 {object} models.Response @Router /notes/{id} [get] @Security ApiKeyAuth
func Login ¶
Login godoc @Summary Login @Description login a user @Tags auth @Accept json @Produce json @Param req body models.LoginRequest true "Login Request" @Success 200 {object} models.Response @Failure 400 {object} models.Response @Router /auth/login [post]
func Ping ¶
Ping godoc @Summary Ping @Description check server @Tags ping @Accept json @Produce json @Success 200 {object} models.Response @Router /ping [get]
func Refresh ¶
Refresh godoc @Summary Refresh @Description refreshes a user token @Tags auth @Accept json @Produce json @Param req body models.RefreshRequest true "Refresh Request" @Success 200 {object} models.Response @Failure 400 {object} models.Response @Router /auth/refresh [post]
func Register ¶
Register godoc @Summary Register @Description registers a user @Tags auth @Accept json @Produce json @Param req body models.RegisterRequest true "Register Request" @Success 200 {object} models.Response @Failure 400 {object} models.Response @Router /auth/register [post]
func UpdateNote ¶
UpdateNote godoc @Summary Update a note @Description updates a note by id @Tags notes @Accept json @Produce json @Param id path string true "Note ID" @Param req body models.NoteRequest true "Note Request" @Success 200 {object} models.Response @Failure 400 {object} models.Response @Router /notes/{id} [put] @Security ApiKeyAuth
Types ¶
This section is empty.
Source Files