workspace

Documentation

Index

• func CreateWorkspace(ctx *gin.Context)
• func DeleteWorkspace(ctx *gin.Context)
• func FindWorkspace(ctx *gin.Context)
• func GetWorkspaceState(ctx *gin.Context)
• func ListWorkspaces(ctx *gin.Context)
• func RestartWorkspace(ctx *gin.Context)
• func StartWorkspace(ctx *gin.Context)
• func StopWorkspace(ctx *gin.Context)
• func UpdateWorkspaceLabels(ctx *gin.Context)
• func UpdateWorkspaceMetadata(ctx *gin.Context)
• func UpdateWorkspaceProviderMetadata(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	CreateWorkspaceDTO	true	"Create workspace"
@Produce		json
@Success		200	{object}	WorkspaceDTO
@Router			/workspace [post]

@id				CreateWorkspace

func DeleteWorkspace

func DeleteWorkspace(ctx *gin.Context)

DeleteWorkspace godoc

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

@id				DeleteWorkspace

func FindWorkspace

func FindWorkspace(ctx *gin.Context)

FindWorkspace godoc

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

@id				FindWorkspace

func GetWorkspaceState

func GetWorkspaceState(ctx *gin.Context)

GetWorkspaceState godoc

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

@id				GetWorkspaceState

func ListWorkspaces

func ListWorkspaces(ctx *gin.Context)

ListWorkspaces godoc

@Tags			workspace
@Summary		List workspaces
@Description	List workspaces
@Param			labels	query	string	false	"JSON encoded labels"
@Produce		json
@Success		200	{array}	WorkspaceDTO
@Router			/workspace [get]

@id				ListWorkspaces

func RestartWorkspace

func RestartWorkspace(ctx *gin.Context)

RestartWorkspace godoc

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

@id				RestartWorkspace

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 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

func UpdateWorkspaceLabels

func UpdateWorkspaceLabels(ctx *gin.Context)

UpdateWorkspaceLabels godoc

@Tags			workspace
@Summary		Update workspace labels
@Description	Update workspace labels
@Param			workspaceId	path		string				true	"Workspace ID or Name"
@Param			labels		body		map[string]string	true	"Labels"
@Success		200			{object}	WorkspaceDTO
@Router			/workspace/{workspaceId}/labels [post]

@id				UpdateWorkspaceLabels

func UpdateWorkspaceMetadata

func UpdateWorkspaceMetadata(ctx *gin.Context)

UpdateWorkspaceMetadata godoc

@Tags			workspace
@Summary		Update workspace metadata
@Description	Update workspace metadata
@Param			workspaceId			path	string						true	"Workspace ID"
@Param			workspaceMetadata	body	UpdateWorkspaceMetadataDTO	true	"Workspace Metadata"
@Success		200
@Router			/workspace/{workspaceId}/metadata [post]

@id				UpdateWorkspaceMetadata

func UpdateWorkspaceProviderMetadata

func UpdateWorkspaceProviderMetadata(ctx *gin.Context)

UpdateWorkspaceProviderMetadata godoc

@Tags			workspace
@Summary		Update workspace provider metadata
@Description	Update workspace provider metadata
@Param			workspaceId	path	string								true	"Workspace ID"
@Param			metadata	body	UpdateWorkspaceProviderMetadataDTO	true	"Provider metadata"
@Success		200
@Router			/workspace/{workspaceId}/provider-metadata [post]

@id				UpdateWorkspaceProviderMetadata