package
0.0.0-20240517125536-29d320c449f8
Repository: https://github.com/abinba/codereview.git
Documentation: pkg.go.dev
# Functions
CreateCodeSnippet godoc @Summary Create a code snippet @Description Create a code snippet @Tags Code Snippets @Accept json @Produce json @Param code_snippet body CodeSnippetForm true "Code Snippet information to create" @Success 201 {object} model.CodeSnippet @Router /api/v1/code_snippet/ [post].
CreateCodeSnippetVersion godoc @Summary Create a code snippet version @Description Create a code snippet version @Tags Code Snippets Versions @Accept json @Produce json @Param code_snippet body model.CodeSnippetVersion true "Code Snippet information to create" @Success 201 {object} model.CodeSnippetVersion @Router /api/v1/code_snippet_version/ [post].
CreateProgramLanguage godoc @Summary Create a program language @Description Create a program language @Tags Program Languages @Accept json @Produce json @Param name body ProgramLanguageForm true "Name of the program language" @Success 201 {object} model.ProgramLanguage @Router /api/v1/program_language/ [post].
CreateReviewComment creates a review comment.
CreateUser godoc @Summary Create a new user @Description create a new user with the provided information @Tags users @Accept json @Produce json @Param user body User true "User to create" example("{\"username\": \"John Doe\", \"password\": \"nothing\"}") @Success 201 {object} model.User @Router /api/v1/register/ [post].
DeleteCodeSnippetByID godoc @Summary Delete a code snippet @Description Delete a code snippet by ID @Tags Code Snippets @Accept json @Produce json @Param id path int true "Code Snippet ID" @Success 200 {object} model.CodeSnippet @Router /api/v1/code_snippet/{id} [delete].
DeleteUserByID godoc @Summary Delete a user @Description delete a user by ID @Tags users @Accept json @Produce json @Param id path int true "User ID" @Success 204 "User deleted" @Router /api/v1/user/{id} [delete].
No description provided by the author
GetAllCodeSnippets godoc @Summary Get all code snippets @Description Get all code snippets @Tags Code Snippets @Accept json @Produce json @Success 200 {array} model.CodeSnippet @Router /api/v1/code_snippet/ [get].
GetAllProgramLanguages godoc @Summary Get all program languages @Description Get all program languages @Tags Program Languages @Accept json @Produce json @Success 200 {array} model.ProgramLanguage @Router /api/v1/program_language/ [get].
GetNotificationsByUserID godoc @Summary Get user notifications @Description Retrieve all notifications for a specific user @Tags Notifications @Accept json @Produce json @Param id path string true "User ID" @Success 200 {array} model.Notification @Router /api/v1/notifications/{id} [get].
GetAllReviewComments godoc @Summary Get all review comments @Description Get all review comments @Tags Review Comments @Accept json @Produce json @Success 200 {array} model.ReviewComment @Router /api/v1/review_comment/ [get].
GetSingleCodeSnippet godoc @Summary Get a single code snippet @Description Get a single code snippet by ID @Tags Code Snippets @Accept json @Produce json @Param id path int true "Code Snippet ID" @Success 200 {object} model.CodeSnippet @Router /api/v1/code_snippet/{id} [get].
GetSingleUser godoc @Summary Get single user @Description get details of user by ID @Tags users @Accept json @Produce json @Param id path int true "User ID" @Success 200 {object} model.User @Router /api/v1/user/{id} [get].
GetUserCodeSnippets godoc @Summary Get user's code snippets @Description Retrieve all code snippets created by a specific user @Tags User Code Snippets @Accept json @Produce json @Param user_id path string true "User ID" @Success 200 {array} model.CodeSnippet @Router /api/v1/user_code_snippets/{user_id} [get].
Login godoc @Summary User login @Description login a user by username and password @Tags users @Accept json @Produce json @Param credentials body User true "Login credentials" example("{\"username\": \"johndoe\", \"password\": \"p@ssword123\"}") @Success 200 {string} string "login successful" @Failure 401 {string} string "invalid credentials" @Router /api/v1/login [post].
UpdateUser godoc @Summary Update an existing user @Description update user's information by ID @Tags users @Accept json @Produce json @Param id path int true "User ID" @Param user body User true "User information to update" @Success 200 {object} model.User @Router /api/v1/user/{id} [put].
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author