Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DeleteProject ¶
@Summary Delete a project @Description Delete a project @Tags framework/projects @Accept application/json @Success 200 @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /projects/:projectName [delete]
func GetProject ¶
@Summary Get a project @Description Get a 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 GetProjectCheck ¶
@Summary Get project exist check @Description Get project exist check @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}/check [get]
func GetProjects ¶
@Summary Get list of projects @Description GET /projects?page=1&pageSize=10 @Tags framework/projects @Param page query int false "query" @Param pageSize query int false "query" @Success 200 {object} PaginatedProjects @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /projects [get]
func PatchProject ¶
@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 ¶
@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.ApiOutputProject `json:"projects"`
Count int64 `json:"count"`
}
Source Files