toolbox

package
v0.53.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 7, 2025 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateSession added in v0.52.0 

func CreateSession(ctx *gin.Context)

CreateSession godoc 

@Tags			workspace toolbox
@Summary		Create exec session
@Description	Create exec session inside workspace project
@Produce		json
@Param			workspaceId	path	string					true	"Workspace ID or Name"
@Param			params		body	CreateSessionRequest	true	"Create session request"
@Success		201
@Router			/workspace/{workspaceId}/toolbox/process/session [post]

@id				CreateSession

func DeleteSession added in v0.52.0 

func DeleteSession(ctx *gin.Context)

DeleteSession godoc 

@Tags			workspace toolbox
@Summary		Delete session
@Description	Delete a session inside workspace project
@Produce		json
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Param			sessionId	path	string	true	"Session ID"
@Success		204
@Router			/workspace/{workspaceId}/toolbox/process/session/{sessionId} [delete]

@id				DeleteSession

func FsCreateFolder 

func FsCreateFolder(ctx *gin.Context)

FsCreateFolder godoc 

@Tags			workspace toolbox
@Summary		Create folder
@Description	Create folder inside a workspace
@Produce		json
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Param			path		query	string	true	"Path"
@Param			mode		query	string	true	"Mode"
@Success		201
@Router			/workspace/{workspaceId}/toolbox/files/folder [post]

@id				FsCreateFolder

func FsDeleteFile 

func FsDeleteFile(ctx *gin.Context)

FsDeleteFile godoc 

@Tags			workspace toolbox
@Summary		Delete file
@Description	Delete file inside a workspace
@Produce		json
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Param			path		query	string	true	"Path"
@Success		204
@Router			/workspace/{workspaceId}/toolbox/files [delete]

@id				FsDeleteFile

func FsDownloadFile 

func FsDownloadFile(ctx *gin.Context)

FsDownloadFile godoc 

@Tags			workspace toolbox
@Summary		Download file
@Description	Download file from a workspace
@Produce		json
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Param			path		query	string	true	"Path"
@Success		200			{file}	file	"response contains the file"
@Router			/workspace/{workspaceId}/toolbox/files/download [get]

@id				FsDownloadFile

func FsFindInFiles 

func FsFindInFiles(ctx *gin.Context)

FsFindInFiles godoc 

@Tags			workspace toolbox
@Summary		Search for text/pattern in files
@Description	Search for text/pattern inside a workspace files
@Produce		json
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Param			path		query	string	true	"Path"
@Param			pattern		query	string	true	"Pattern"
@Success		200			{array}	Match
@Router			/workspace/{workspaceId}/toolbox/files/find [get]

@id				FsFindInFiles

func FsGetFileDetails 

func FsGetFileDetails(ctx *gin.Context)

FsGetFileDetails godoc 

@Tags			workspace toolbox
@Summary		Get file info
@Description	Get file info inside a workspace
@Produce		json
@Param			workspaceId	path		string	true	"Workspace ID or Name"
@Param			path		query		string	true	"Path"
@Success		200			{object}	FileInfo
@Router			/workspace/{workspaceId}/toolbox/files/info [get]

@id				FsGetFileDetails

func FsListFiles 

func FsListFiles(ctx *gin.Context)

FsListFiles godoc 

@Tags			workspace toolbox
@Summary		List files
@Description	List files inside a workspace
@Produce		json
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Param			path		query	string	false	"Path"
@Success		200			{array}	FileInfo
@Router			/workspace/{workspaceId}/toolbox/files [get]

@id				FsListFiles

func FsMoveFile 

func FsMoveFile(ctx *gin.Context)

FsMoveFile godoc 

@Tags			workspace toolbox
@Summary		Create folder
@Description	Create folder inside a workspace
@Produce		json
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Param			source		query	string	true	"Source path"
@Param			destination	query	string	true	"Destination path"
@Success		200
@Router			/workspace/{workspaceId}/toolbox/files/move [post]

@id				FsMoveFile

func FsReplaceInFiles 

func FsReplaceInFiles(ctx *gin.Context)

FsReplaceInFiles godoc 

@Tags			workspace toolbox
@Summary		Repleace text/pattern in files
@Description	Repleace text/pattern in mutilple files inside a workspace
@Produce		json
@Param			workspaceId	path	string			true	"Workspace ID or Name"
@Param			replace		body	ReplaceRequest	true	"ReplaceParams"
@Success		200			{array}	ReplaceResult
@Router			/workspace/{workspaceId}/toolbox/files/replace [post]

@id				FsReplaceInFiles

func FsSearchFiles 

func FsSearchFiles(ctx *gin.Context)

FsSearchFiles godoc 

@Tags			workspace toolbox
@Summary		Search for files
@Description	Search for files inside a workspace
@Produce		json
@Param			workspaceId	path		string	true	"Workspace ID or Name"
@Param			path		query		string	true	"Path"
@Param			pattern		query		string	true	"Pattern"
@Success		200			{object}	SearchFilesResponse
@Router			/workspace/{workspaceId}/toolbox/files/search [get]

@id				FsSearchFiles

func FsSetFilePermissions 

func FsSetFilePermissions(ctx *gin.Context)

FsSetFilePermissions godoc 

@Tags			workspace toolbox
@Summary		Set file owner/group/permissions
@Description	Set file owner/group/permissions inside a workspace
@Produce		json
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Param			path		query	string	true	"Path"
@Param			owner		query	string	false	"Owner"
@Param			group		query	string	false	"Group"
@Param			mode		query	string	false	"Mode"
@Success		200
@Router			/workspace/{workspaceId}/toolbox/files/permissions [post]

@id				FsSetFilePermissions

func FsUploadFile 

func FsUploadFile(ctx *gin.Context)

FsUploadFile godoc 

@Tags			workspace toolbox
@Summary		Upload file
@Description	Upload file inside a workspace
@Produce		json
@Param			workspaceId	path		string	true	"Workspace ID or Name"
@Param			path		query		string	true	"Path"
@Param			file		formData	file	true	"File"
@Success		200
@Router			/workspace/{workspaceId}/toolbox/files/upload [post]

@id				FsUploadFile

func GetSessionCommandLogs added in v0.52.0 

func GetSessionCommandLogs(ctx *gin.Context)

GetSessionCommandLogs godoc 

@Tags			workspace toolbox
@Summary		Get session command logs
@Description	Get logs of a command inside a session inside workspace project
@Description	Connect with websocket to get a stream of the logs
@Param			workspaceId	path		string	true	"Workspace ID or Name"
@Param			sessionId	path		string	true	"Session ID"
@Param			commandId	path		string	true	"Command ID"
@Success		200			{string}	string	"command logs"
@Router			/workspace/{workspaceId}/toolbox/process/session/{sessionId}/command/{commandId}/logs [get]

@id				GetSessionCommandLogs

func GetWorkspaceDir added in v0.52.0 

func GetWorkspaceDir(ctx *gin.Context)

GetWorkspaceDir godoc 

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

@id				GetWorkspaceDir

func GitAddFiles 

func GitAddFiles(ctx *gin.Context)

GitAddFiles godoc 

@Tags			workspace toolbox
@Summary		Add files
@Description	Add files to git commit
@Produce		json
@Param			workspaceId	path	string			true	"Workspace ID or Name"
@Param			params		body	GitAddRequest	true	"GitAddRequest"
@Success		200
@Router			/workspace/{workspaceId}/toolbox/git/add [post]

@id				GitAddFiles

func GitBranchList 

func GitBranchList(ctx *gin.Context)

GitBranchList godoc 

@Tags			workspace toolbox
@Summary		Get branch list
@Description	Get branch list from git repository inside a workspace
@Produce		json
@Param			workspaceId	path		string	true	"Workspace ID or Name"
@Param			path		query		string	true	"Path to git repository"
@Success		200			{object}	ListBranchResponse
@Router			/workspace/{workspaceId}/toolbox/git/branches [get]

@id				GitBranchList

func GitCloneRepository 

func GitCloneRepository(ctx *gin.Context)

GitCloneRepository godoc 

@Tags			workspace toolbox
@Summary		Clone git repository
@Description	Clone git repository inside a workspace
@Produce		json
@Param			workspaceId	path	string			true	"Workspace ID or Name"
@Param			params		body	GitCloneRequest	true	"GitCloneRequest"
@Success		200
@Router			/workspace/{workspaceId}/toolbox/git/clone [post]

@id				GitCloneRepository

func GitCommitChanges 

func GitCommitChanges(ctx *gin.Context)

GitCommitChanges godoc 

@Tags			workspace toolbox
@Summary		Commit changes
@Description	Commit changes to git repository inside a workspace
@Produce		json
@Param			workspaceId	path		string				true	"Workspace ID or Name"
@Param			params		body		GitCommitRequest	true	"GitCommitRequest"
@Success		200			{object}	GitCommitResponse
@Router			/workspace/{workspaceId}/toolbox/git/commit [post]

@id				GitCommitChanges

func GitCommitHistory 

func GitCommitHistory(ctx *gin.Context)

GitCommitHistory godoc 

@Tags			workspace toolbox
@Summary		Get commit history
@Description	Get commit history from git repository inside a workspace
@Produce		json
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Param			path		query	string	true	"Path to git repository"
@Success		200			{array}	GitCommitInfo
@Router			/workspace/{workspaceId}/toolbox/git/history [get]

@id				GitCommitHistory

func GitCreateBranch 

func GitCreateBranch(ctx *gin.Context)

GitCreateBranch godoc 

@Tags			workspace toolbox
@Summary		Create branch
@Description	Create branch on git repository inside a workspace
@Produce		json
@Param			workspaceId	path	string				true	"Workspace ID or Name"
@Param			params		body	GitBranchRequest	true	"GitBranchRequest"
@Success		201
@Router			/workspace/{workspaceId}/toolbox/git/branches [post]

@id				GitCreateBranch

func GitPullChanges 

func GitPullChanges(ctx *gin.Context)

GitPullChanges godoc 

@Tags			workspace toolbox
@Summary		Pull changes
@Description	Pull changes from remote to git repository inside a workspace
@Produce		json
@Param			workspaceId	path	string			true	"Workspace ID or Name"
@Param			params		body	GitRepoRequest	true	"Git pull request"
@Success		200
@Router			/workspace/{workspaceId}/toolbox/git/pull [post]

@id				GitPullChanges

func GitPushChanges 

func GitPushChanges(ctx *gin.Context)

GitPushChanges godoc 

@Tags			workspace toolbox
@Summary		Push changes
@Description	Push changes to remote from git repository inside a workspace
@Produce		json
@Param			workspaceId	path	string			true	"Workspace ID or Name"
@Param			params		body	GitRepoRequest	true	"Git push request"
@Success		200
@Router			/workspace/{workspaceId}/toolbox/git/push [post]

@id				GitPushChanges

func GitStatus 

func GitStatus(ctx *gin.Context)

GitStatus godoc 

@Tags			workspace toolbox
@Summary		Get git status
@Description	Get status from git repository inside a workspace
@Produce		json
@Param			workspaceId	path		string	true	"Workspace ID or Name"
@Param			path		query		string	true	"Path to git repository"
@Success		200			{object}	GitStatus
@Router			/workspace/{workspaceId}/toolbox/git/status [get]

@id				GitGitStatus

func ListSessions added in v0.52.0 

func ListSessions(ctx *gin.Context)

ListSessions godoc 

@Tags			workspace toolbox
@Summary		List sessions
@Description	List sessions inside workspace project
@Produce		json
@Param			workspaceId	path	string	true	"Workspace ID or Name"
@Success		200			{array}	Session
@Router			/workspace/{workspaceId}/toolbox/process/session [get]

@id				ListSessions

func LspCompletions 

func LspCompletions(ctx *gin.Context)

LspCompletions godoc 

@Tags			workspace toolbox
@Summary		Get Lsp Completions
@Description	The Completion request is sent from the client to the server to compute completion items at a given cursor position.
@Produce		json
@Param			workspaceId	path		string				true	"Workspace ID or Name"
@Param			params		body		LspCompletionParams	true	"LspCompletionParams"
@Success		200			{object}	CompletionList
@Router			/workspace/{workspaceId}/toolbox/lsp/completions [post]

@id				LspCompletions

func LspDidClose 

func LspDidClose(ctx *gin.Context)

LspDidClose godoc 

@Tags			workspace toolbox
@Summary		Call Lsp DidClose
@Description	The document close notification is sent from the client to the server when the document got closed in the client.
@Produce		json
@Param			workspaceId	path	string				true	"Workspace ID or Name"
@Param			params		body	LspDocumentRequest	true	"LspDocumentRequest"
@Success		200
@Router			/workspace/{workspaceId}/toolbox/lsp/did-close [post]

@id				LspDidClose

func LspDidOpen 

func LspDidOpen(ctx *gin.Context)

LspDidOpen godoc 

@Tags			workspace toolbox
@Summary		Call Lsp DidOpen
@Description	The document open notification is sent from the client to the server to signal newly opened text documents.
@Produce		json
@Param			workspaceId	path	string				true	"Workspace ID or Name"
@Param			params		body	LspDocumentRequest	true	"LspDocumentRequest"
@Success		200
@Router			/workspace/{workspaceId}/toolbox/lsp/did-open [post]

@id				LspDidOpen

func LspDocumentSymbols 

func LspDocumentSymbols(ctx *gin.Context)

LspDocumentSymbols godoc 

@Tags			workspace toolbox
@Summary		Call Lsp DocumentSymbols
@Description	The document symbol request is sent from the client to the server.
@Produce		json
@Param			workspaceId		path	string	true	"Workspace ID or Name"
@Param			languageId		query	string	true	"Language ID"
@Param			pathToProject	query	string	true	"Path to project"
@Param			uri				query	string	true	"Document Uri"
@Success		200				{array}	LspSymbol
@Router			/workspace/{workspaceId}/toolbox/lsp/document-symbols [get]

@id				LspDocumentSymbols

func LspStart 

func LspStart(ctx *gin.Context)

LspStart godoc 

@Tags			workspace toolbox
@Summary		Start Lsp server
@Description	Start Lsp server process inside a workspace
@Produce		json
@Param			workspaceId	path	string				true	"Workspace ID or Name"
@Param			params		body	LspServerRequest	true	"LspServerRequest"
@Success		200
@Router			/workspace/{workspaceId}/toolbox/lsp/start [post]

@id				LspStart

func LspStop 

func LspStop(ctx *gin.Context)

LspStop godoc 

@Tags			workspace toolbox
@Summary		Stop Lsp server
@Description	Stop Lsp server process inside a workspace
@Produce		json
@Param			workspaceId	path	string				true	"Workspace ID or Name"
@Param			params		body	LspServerRequest	true	"LspServerRequest"
@Success		200
@Router			/workspace/{workspaceId}/toolbox/lsp/stop [post]

@id				LspStop

func LspWorkspaceSymbols 

func LspWorkspaceSymbols(ctx *gin.Context)

LspWorkspaceSymbols godoc 

@Tags			workspace toolbox
@Summary		Call Lsp WorkspaceSymbols
@Description	The workspace symbol request is sent from the client to the server to list project-wide symbols matching the query string.
@Produce		json
@Param			workspaceId		path	string	true	"Workspace ID or Name"
@Param			languageId		query	string	true	"Language ID"
@Param			pathToProject	query	string	true	"Path to project"
@Param			query			query	string	true	"Symbol Query"
@Success		200				{array}	LspSymbol
@Router			/workspace/{workspaceId}/toolbox/lsp/workspace-symbols [get]

@id				LspWorkspaceSymbols

func ProcessExecuteCommand 

func ProcessExecuteCommand(ctx *gin.Context)

ProcessExecuteCommand godoc 

@Tags			workspace toolbox
@Summary		Execute command
@Description	Execute command synchronously inside a workspace
@Produce		json
@Param			workspaceId	path		string			true	"Workspace ID or Name"
@Param			params		body		ExecuteRequest	true	"Execute command request"
@Success		200			{object}	ExecuteResponse
@Router			/workspace/{workspaceId}/toolbox/process/execute [post]

@id				ProcessExecuteCommand

func SessionExecuteCommand added in v0.52.0 

func SessionExecuteCommand(ctx *gin.Context)

SessionExecuteCommand godoc 

@Tags			workspace toolbox
@Summary		Execute command in session
@Description	Execute command inside a session inside workspace project
@Produce		json
@Param			workspaceId	path		string					true	"Workspace ID or Name"
@Param			sessionId	path		string					true	"Session ID"
@Param			params		body		SessionExecuteRequest	true	"Execute command request"
@Success		200			{object}	SessionExecuteResponse
@Router			/workspace/{workspaceId}/toolbox/process/session/{sessionId}/exec [post]

@id				SessionExecuteCommand

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.