project

Documentation

Index

• func GetProject(c *gin.Context)
• func GetProjects(c *gin.Context)
• func PatchProject(c *gin.Context)
• func PostProject(c *gin.Context)
• type PaginatedProjects

Functions

func GetProject

func GetProject(c *gin.Context)

@Summary Create and run a new project @Description Create and run a new project @Tags framework/projects @Accept application/json @Param projectName path string true "project name" @Success 200 {object} models.ApiOutputProject @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /projects/:projectName [get]

func GetProjects

func GetProjects(c *gin.Context)

@Summary Get list of projects @Description GET /projects?page=1&pageSize=10 @Tags framework/projects @Param page query int true "query" @Param pageSize query int true "query" @Success 200 {object} PaginatedProjects @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /projects [get]

func PatchProject

func PatchProject(c *gin.Context)

@Summary Patch a project @Description Patch a project @Tags framework/projects @Accept application/json @Param project body models.ApiInputProject true "json" @Success 200 {object} models.ApiOutputProject @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /projects/:projectName [patch]

func PostProject

func PostProject(c *gin.Context)

@Summary Create a new project @Description Create a new project @Tags framework/projects @Accept application/json @Param project body models.ApiInputProject true "json" @Success 200 {object} models.ApiOutputProject @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /projects [post]

Types

type PaginatedProjects

type PaginatedProjects struct {
	Projects []*models.Project `json:"projects"`
	Count    int64             `json:"count"`
}