package
0.1.0-beta4.1
Repository: https://github.com/memnix/memnixrest.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
CreateMcq method @Description Create a new mcq @Summary creates a mcq @Tags Mcq @Produce json @Accept json @Param mcq body models.Mcq true "Mcq to create" @Success 200 @Router /v1/mcqs/new [post].
CreateNewCard method @Description Create a new card @Summary creates a card @Tags Card @Produce json @Accept json @Param card body models.Card true "Card to create" @Success 200 @Router /v1/cards/new [post].
CreateNewDeck method @Description Create a new deck @Summary creates a deck @Tags Deck @Produce json @Success 200 @Accept json @Param deck body models.Deck true "Deck to create" @Router /v1/decks/new [post].
DeleteCardById method @Description Delete a card @Summary deletes a card @Tags Card @Produce json @Success 200 @Router /v1/cards/{cardID} [delete].
DeleteDeckById method @Description Delete a deck @Summary delete a deck @Tags Deck @Produce json @Success 200 @Router /v1/decks/{deckID} [delete].
DeleteMcqById method @Description Delete a mcq @Summary deletes a mcq @Tags Mcq @Produce json @Success 200 @Router /v1/mcqs/{mcqID} [delete].
GetAllAvailableDecks method to get a list of deck @Description Get all public deck that you are not sub to @Summary get a list of deck @Tags Deck @Produce json @Success 200 {array} models.ResponseDeck @Router /v1/decks/available [get].
GetAllCards method @Description Get every card.
GetAllDecks method to get all decks @Description Get every deck.
GetAllEditorDecks method to get a deck @Description Get decks the user is an editor @Summary gets a list of deck @Tags Deck @Produce json @Success 200 {array} models.ResponseDeck @Router /v1/decks/editor [get].
GetAllPublicDecks method to get a list of deck @Description Get all public deck @Summary gets a list of deck @Tags Deck @Produce json @Success 200 {array} models.Deck @Router /v1/decks/public [get].
GetAllSubDecks method to get a deck @Description Get decks a user is sub to @Summary gets a list of deck @Tags Deck @Produce json @Success 200 {array} models.ResponseDeck @Router /v1/decks/sub [get].
GetAllSubUsers method to get a list of users @Description Get all the sub users to a deck @Summary gets a list of users @Tags Deck @Produce json @Success 200 {array} models.User @Router /v1/decks/{deckID}/users [get].
GetAllTodayCard method @Description Get all today card @Summary gets a list of card @Tags Card @Produce json @Success 200 {array} models.Card @Router /v1/cards/today [get].
GetAllUsers method to get all users @Description Get all users.
GetCardByID method to get a card by id @Description Get a card by tech id @Summary gets a card @Tags Card @Produce json @Param id path int true "Card ID" @Success 200 {object} models.Card @Router /v1/cards/id/{id} [get].
GetCardsFromDeck method to get cards from deck @Description Get every card from a deck @Summary gets a list of card @Tags Card @Produce json @Param deckID path int true "Deck ID" @Success 200 {array} models.Card @Router /v1/cards/deck/{deckID} [get].
GetDeckByID method to get a deck @Description Get a deck by tech ID @Summary get a deck @Tags Deck @Produce json @Param id path int true "Deck ID" @Success 200 {model} models.Deck @Router /v1/decks/{deckID} [get].
GetMcqsByDeck method @Description Get mcqs linked to the deck @Summary gets a list of mcqs @Tags Mcq @Produce json @Success 200 {array} models.Mcq @Router /v1/mcqs/{deckID} [get].
GetNextCard method @Description Get next card @Summary gets a card @Tags Card @Deprecated @Produce json @Success 200 {object} models.Card @Router /v1/cards/next [get].
GetNextCardByDeck method @Description Get next card by deckID @Summary get a card @Tags Card @Produce json @Deprecated @Success 200 {object} models.Card @Router /v1/cards/{deckID}/next [get].
GetTodayCard method @Description Get next today card @Summary gets a card @Tags Card @Produce json @Success 200 {object} models.Card @Deprecated @Router /v1/cards/today/one [get].
GetTrainingCardsByDeck method @Description Get training cards @Summary gets a list of cards @Tags Card @Produce json @Success 200 {array} models.Card @Router /v1/cards/{deckID}/training [get].
GetUserByID method to get a user @Description Get a user by ID.
Login method to login user and return access with fresh token as a cookie @Description Login user and return access with fresh token as a cookie @Summary logins user and return access with fresh token as a cookie @Tags Auth @Produce json @Param email body string true "Email" @Param password body string true "Password" @Success 200 {object} models.User @Failure 404 "Error" @Failure 400 "Incorrect password" @Failure 500 "Internal error" @Router /login [post].
Logout method to de-auth connected user and delete token @Description Logout to de-auth connected user and delete token @Summary logouts and de-auth connected user and delete token @Tags Auth @Produce json @Success 200 "Logout" @Failure 404 "Error" @Failure 401 "Forbidden" @Security ApiKeyAuth[user] @Router /logout [post].
PostResponse method @Description Post a response and check it @Summary posts a response @Tags Card @Produce json @Success 200 @Accept json @Router /v1/cards/response [post].
Register method to create a new user @Description Register a new user @Summary registers a new user @Tags Auth @Produce json @Param email body string true "Email" @Param password body string true "Password" @Param username body string true "Username" @Success 200 {object} models.User @Failure 404 "Error" @Failure 403 "Forbidden" @Router /register [post].
SetTodayConfig method to set a config @Description Set the today config for a deck @Summary gets a user @Tags User @Produce json @Param id path int true "ID" @Success 200 {object} models.User @Router /v1/users/config/{deckId}/today [get].
SubToDeck method @Description Subscribe to a deck @Summary sub deck @Tags Deck @Produce json @Success 200 @Accept json @Router /v1/decks/{deckID}/subscribe [post].
UnSubToDeck method @Description Unsubscribe to a deck @Summary unsub deck @Tags Deck @Produce json @Success 200 @Accept json @Router /v1/decks/{deckID}/unsubscribe [post].
UpdateCard function.
UpdateCardByID method @Description Edit a card @Summary edits a card @Tags Card @Produce json @Success 200 @Accept json @Param card body models.Card true "card to edit" @Router /v1/cards/{cardID}/edit [put].
UpdateDeck function.
UpdateDeckByID method @Description Edit a deck @Summary edits a deck @Tags Deck @Produce json @Success 200 @Accept json @Param deck body models.Deck true "Deck to edit" @Router /v1/decks/{deckID}/edit [put].
UpdateMcq function.
UpdateMcqById method @Description Edit a mcq @Summary edits a mcq @Tags Mcq @Produce json @Success 200 @Accept json @Param mcq body models.Mcq true "mcq to edit" @Router /v1/mcqs/{mcqID}/edit [put].
UpdateUser function.
UpdateUserByID function.
User method to get connected user @Description To get connected user @Summary gets connected user @Tags Auth @Produce json @Success 200 {object} models.User @Failure 404 "Error" @Failure 401 "Forbidden" @Security ApiKeyAuth @Router /user [get].

# Variables

No description provided by the author