project

Documentation

Index

• func CreateProject(ctx *gin.Context)
• func DeleteProject(ctx *gin.Context)
• func GetProjectId(ctx *gin.Context)
• func ListProject(ctx *gin.Context)
• func ProjectRouter(r *gin.RouterGroup)
• func UpdateProject(ctx *gin.Context)
• type CreateProjectRequestBody
• type ErrorResp
• type Project
• type SuccessResp
• type UpdateProjectRequestBody

Functions

func CreateProject

func CreateProject(ctx *gin.Context)

@BasePath /api/v1 PingProject godoc @Summary CreateProject @Schemes @Description Create Project @Tags CreateProject @Accept json @Produce json @Security ApiKeyAuth @Param ReqeustBody body CreateProjectRequestBody true "Create Project" @Success 200 {object} util.Res {"code":200,"data":null,"msg":""} @Success 400 {object} util.Res {"code":400,"data":null,"msg":""} @Success 404 {object} util.Res {"code":404,"data":null,"msg":""} @Success 500 {object} util.Res {"code":500,"data":null,"msg":""} @Router /project/create [post] @ID CreateProject

func DeleteProject

func DeleteProject(ctx *gin.Context)

@BasePath /api/v1 PingProject godoc @Summary DeleteProject @Schemes @Description Delete Project @Tags DeleteProject @Accept json @Produce json @Security ApiKeyAuth @Param project_name query string true "Project_Name" @Success 200 {object} util.Res {"code":200,"data":null,"msg":""} @Success 400 {object} util.Res {"code":400,"data":null,"msg":""} @Success 404 {object} util.Res {"code":404,"data":null,"msg":""} @Success 500 {object} util.Res {"code":500,"data":null,"msg":""} @Router /project/delete [delete] @ID DeleteProject

func GetProjectId

func GetProjectId(ctx *gin.Context)

@BasePath /api/v1 PingProject godoc @Summary GetProjectId @Schemes @Description Get ProjectID @Tags GetProjectId @Accept json @Produce json @Security ApiKeyAuth @Param project_name query string true "Project Name" @Success 200 {object} util.Res {"code":200,"data":null,"msg":""} @Success 400 {object} util.Res {"code":400,"data":null,"msg":""} @Success 404 {object} util.Res {"code":404,"data":null,"msg":""} @Success 500 {object} util.Res {"code":500,"data":null,"msg":""} @Router /project/get_id [get] @ID GetProjectId

func ListProject

func ListProject(ctx *gin.Context)

@BasePath /api/v1 PingProject godoc @Summary ListProject @Schemes @Description List Project @Tags ListProject @Accept json @Produce json @Security ApiKeyAuth @Param project_name query string false "Project Name" @Success 200 {object} util.Res {"code":200,"data":null,"msg":""} @Success 400 {object} util.Res {"code":400,"data":null,"msg":""} @Success 404 {object} util.Res {"code":404,"data":null,"msg":""} @Success 500 {object} util.Res {"code":500,"data":null,"msg":""} @Router /project/list [get] @ID ListProject

func ProjectRouter

func ProjectRouter(r *gin.RouterGroup)

func UpdateProject

func UpdateProject(ctx *gin.Context)

@BasePath /api/v1 PingProject godoc @Summary UpdateProject @Schemes @Description Update Project @Tags UpdateProject @Accept json @Produce json @Security ApiKeyAuth @Param project_id query string true "Project_ID" @Param ReqeustBody body CreateProjectRequestBody true "Update Project" @Success 200 {object} util.Res {"code":200,"data":null,"msg":""} @Success 400 {object} util.Res {"code":400,"data":null,"msg":""} @Success 404 {object} util.Res {"code":404,"data":null,"msg":""} @Success 500 {object} util.Res {"code":500,"data":null,"msg":""} @Router /project/update [put] @ID UpdateProject

Types

type CreateProjectRequestBody

type CreateProjectRequestBody struct {
	ProjectName string `json:"project_name" binding:"required"`
	Description string `json:"description" binding:"required"`
}

type ErrorResp

type ErrorResp struct {
	Msg string `json:"msg"`
}

type Project

type Project struct {
	Name      string `json:"name"`
	ProjectID int64  `json:"project_id"`
}

type SuccessResp

type SuccessResp struct {
	Msg string `json:"msg"`
}

type UpdateProjectRequestBody

type UpdateProjectRequestBody struct {
	ProjectName string `json:"project_name"`
	Description string `json:"description"`
}