workspace

Documentation

Index

• func CreateWorkspace(ctx *gin.Context)
• func GetWorkspace(ctx *gin.Context)
• func ListWorkspaces(ctx *gin.Context)
• func RemoveWorkspace(ctx *gin.Context)
• func SetProjectState(ctx *gin.Context)
• func StartProject(ctx *gin.Context)
• func StartWorkspace(ctx *gin.Context)
• func StopProject(ctx *gin.Context)
• func StopWorkspace(ctx *gin.Context)

Functions

func CreateWorkspace

func CreateWorkspace(ctx *gin.Context)

CreateWorkspace godoc

@Tags			workspace
@Summary		Create a workspace
@Description	Create a workspace
@Param			workspace	body	CreateWorkspaceRequest	true	"Create workspace"
@Produce		json
@Success		200	{object}	Workspace
@Router			/workspace [post]

@id				CreateWorkspace

func GetWorkspace

func GetWorkspace(ctx *gin.Context)

GetWorkspace godoc

@Tags			workspace
@Summary		Get workspace info
@Description	Get workspace info
@Produce		json
@Param			workspaceId	path		string	true	"Workspace ID or Name"
@Success		200			{object}	WorkspaceDTO
@Router			/workspace/{workspaceId} [get]

@id				GetWorkspace

func ListWorkspaces

func ListWorkspaces(ctx *gin.Context)

ListWorkspaces godoc

@Tags			workspace
@Summary		List workspaces
@Description	List workspaces
@Produce		json
@Success		200	{array}	WorkspaceDTO
@Router			/workspace [get]
@Param			verbose	query	bool	false	"Verbose"

@id				ListWorkspaces

func RemoveWorkspace

func RemoveWorkspace(ctx *gin.Context)

RemoveWorkspace godoc

@Tags			workspace
@Summary		Remove workspace
@Description	Remove workspace
@Param			workspaceId	path	string	true	"Workspace ID"
@Param			force		query	bool	false	"Force"
@Success		200
@Router			/workspace/{workspaceId} [delete]

@id				RemoveWorkspace

func SetProjectState

func SetProjectState(ctx *gin.Context)

SetProjectState godoc

@Tags			workspace
@Summary		Set project state
@Description	Set project state
@Param			workspaceId	path	string			true	"Workspace ID or Name"
@Param			projectId	path	string			true	"Project ID"
@Param			setState	body	SetProjectState	true	"Set State"
@Success		200
@Router			/workspace/{workspaceId}/{projectId}/state [post]

@id				SetProjectState

func StartProject

func StartProject(ctx *gin.Context)

StartProject godoc

@Tags			workspace
@Summary		Start project
@Description	Start project
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Param			projectId	path	string	true	"Project ID"
@Success		200
@Router			/workspace/{workspaceId}/{projectId}/start [post]

@id				StartProject

func StartWorkspace

func StartWorkspace(ctx *gin.Context)

StartWorkspace godoc

@Tags			workspace
@Summary		Start workspace
@Description	Start workspace
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Success		200
@Router			/workspace/{workspaceId}/start [post]

@id				StartWorkspace

func StopProject

func StopProject(ctx *gin.Context)

StopProject godoc

@Tags			workspace
@Summary		Stop project
@Description	Stop project
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Param			projectId	path	string	true	"Project ID"
@Success		200
@Router			/workspace/{workspaceId}/{projectId}/stop [post]

@id				StopProject

func StopWorkspace

func StopWorkspace(ctx *gin.Context)

StopWorkspace godoc

@Tags			workspace
@Summary		Stop workspace
@Description	Stop workspace
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Success		200
@Router			/workspace/{workspaceId}/stop [post]

@id				StopWorkspace