project

package

v0.15.0 Latest Latest Go to latest Published: Jan 31, 2023 License: Apache-2.0, MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/apache/incubator-devlake

Links

Documentation ¶

Index ¶

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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"`
}

Source Files ¶

View all Source files

project.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL