Package io.toolforge.spi.service

Interface WorkspacesApi

@Path("/workspaces")
@Generated(value="org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen",
           date="2023-03-23T19:13:01.140351-05:00[America/Chicago]")
public interface WorkspacesApi

Method Summary

Modifier and Type	Method	Description
Execution	cancelExecution(WorkspaceId workspaceId, ExecutionId executionId)
Blob	createBlob(WorkspaceId workspaceId, @Valid InputStream body)
Secret	createWorkspaceSecret(WorkspaceId workspaceId, @Valid SecretDefinition secretDefinition)
void	deleteExecution(WorkspaceId workspaceId, ExecutionId executionId)
void	deleteWorkspaceSecret(WorkspaceId workspaceId, SecretId secretId)
Execution	executeWorkspaceTool(WorkspaceId workspaceId, ToolId toolId, @Valid ToolInvocation toolInvocation)
Secret	findWorkspaceSecretByName(WorkspaceId workspaceId, String name)
Blob	getBlob(WorkspaceId workspaceId, BlobId blobId)
Execution	getExecution(WorkspaceId workspaceId, ExecutionId executionId)
InputStream	getExecutionInputData(WorkspaceId workspaceId, ExecutionId executionId, String name)
InputStream	getExecutionOutputData(WorkspaceId workspaceId, ExecutionId executionId, String name)
InputStream	getExecutionOutputExtensionData(WorkspaceId workspaceId, ExecutionId executionId, String name, String extension)
Workspace	getWorkspace(WorkspaceId workspaceId)
Secret	getWorkspaceSecret(WorkspaceId workspaceId, SecretId secretId)
Tool	getWorkspaceTool(WorkspaceId workspaceId, ToolId toolId)
LogPage	listExecutionLogs(WorkspaceId workspaceId, ExecutionId executionId, Integer limit, LogCursor cursor)
ExecutionPage	listExecutions(WorkspaceId workspaceId, KeywordQuery q, AccountReference owner, ExecutionState state, @Min(0L) @Max(100L) Integer limit, ExecutionCursor cursor)
WorkspacePage	listWorkspaces(KeywordQuery q, AccountReference owner, @Min(0L) @Max(100L) Integer limit, WorkspaceCursor cursor)
SecretPage	listWorkspaceSecrets(WorkspaceId workspaceId, KeywordQuery q, AccountReference owner, @Min(0L) @Max(100L) Integer limit, SecretCursor cursor)
ToolPage	listWorkspaceTools(WorkspaceId workspaceId, KeywordQuery q, AccountReference owner, ToolListOrdering order, @Min(0L) @Max(100L) Integer limit, ToolCursor cursor)
Execution	transferExecution(WorkspaceId workspaceId, ExecutionId executionId, @Valid ExecutionTransfer executionTransfer)
Secret	transferWorkspaceSecret(WorkspaceId workspaceId, SecretId secretId, @Valid SecretTransfer secretTransfer)
Tool	transferWorkspaceTool(WorkspaceId workspaceId, ToolId toolId, @Valid ToolTransfer toolTransfer)
Execution	updateExecution(WorkspaceId workspaceId, ExecutionId executionId, @Valid ExecutionUpdate executionUpdate)
Secret	updateWorkspaceSecret(WorkspaceId workspaceId, SecretId secretId, @Valid SecretUpdate secretUpdate)
Tool	updateWorkspaceTool(WorkspaceId workspaceId, ToolId toolId, @Valid ToolUpdate toolUpdate)

Method Details

cancelExecution

@POST
@Path("/{workspaceId}/executions/{executionId}/cancel")
@Produces({"application/json","application/problem+json"})
Execution cancelExecution(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("executionId")
 ExecutionId executionId)

createBlob

@POST
@Path("/{workspaceId}/blobs")
@Produces("application/json")
Blob createBlob(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @Valid
 @Valid InputStream body)

createWorkspaceSecret

@POST
@Path("/{workspaceId}/secrets")
@Consumes("application/json")
@Produces({"application/json","application/problem+json"})
Secret createWorkspaceSecret(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @Valid
 @Valid SecretDefinition secretDefinition)

deleteExecution

@DELETE
@Path("/{workspaceId}/executions/{executionId}")
@Produces("application/problem+json")
void deleteExecution(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("executionId")
 ExecutionId executionId)

deleteWorkspaceSecret

@DELETE
@Path("/{workspaceId}/secrets/{secretId}")
@Produces("application/problem+json")
void deleteWorkspaceSecret(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("secretId")
 SecretId secretId)

executeWorkspaceTool

@POST
@Path("/{workspaceId}/tools/{toolId}/execute")
@Consumes("application/json")
@Produces({"application/json","application/problem+json"})
Execution executeWorkspaceTool(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("toolId")
 ToolId toolId,
 @Valid
 @Valid ToolInvocation toolInvocation)

findWorkspaceSecretByName

@GET
@Path("/{workspaceId}/secrets/by/name/{name}")
@Produces({"application/json","application/problem+json"})
Secret findWorkspaceSecretByName(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("name")
 String name)

getBlob

@GET
@Path("/{workspaceId}/blobs/{blobId}")
@Produces({"application/json","application/problem+json"})
Blob getBlob(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("blobId")
 BlobId blobId)

getExecution

@GET
@Path("/{workspaceId}/executions/{executionId}")
@Produces({"application/json","application/problem+json"})
Execution getExecution(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("executionId")
 ExecutionId executionId)

getExecutionInputData

@GET
@Path("/{workspaceId}/executions/{executionId}/inputs/{name}")
@Produces({"*/*","application/problem+json"})
InputStream getExecutionInputData(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("executionId")
 ExecutionId executionId,
 @PathParam("name")
 String name)

getExecutionOutputData

@GET
@Path("/{workspaceId}/executions/{executionId}/outputs/{name}")
@Produces({"*/*","application/json","application/problem+json"})
InputStream getExecutionOutputData(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("executionId")
 ExecutionId executionId,
 @PathParam("name")
 String name)

getExecutionOutputExtensionData

@GET
@Path("/{workspaceId}/executions/{executionId}/outputs/{name}.{extension}")
@Produces({"*/*","application/json","application/problem+json"})
InputStream getExecutionOutputExtensionData(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("executionId")
 ExecutionId executionId,
 @PathParam("name")
 String name,
 @PathParam("extension")
 String extension)

getWorkspace

@GET
@Path("/{workspaceId}")
@Produces({"application/json","application/problem+json"})
Workspace getWorkspace(@PathParam("workspaceId")
 WorkspaceId workspaceId)

getWorkspaceSecret

@GET
@Path("/{workspaceId}/secrets/{secretId}")
@Produces({"application/json","application/problem+json"})
Secret getWorkspaceSecret(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("secretId")
 SecretId secretId)

getWorkspaceTool

@GET
@Path("/{workspaceId}/tools/{toolId}")
@Produces({"application/json","application/problem+json"})
Tool getWorkspaceTool(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("toolId")
 ToolId toolId)

listExecutionLogs

@GET
@Path("/{workspaceId}/executions/{executionId}/logs")
@Produces({"application/json","application/problem+json"})
LogPage listExecutionLogs(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("executionId")
 ExecutionId executionId,
 @QueryParam("limit") @DefaultValue("10")
 Integer limit,
 @QueryParam("cursor")
 LogCursor cursor)

listExecutions

@GET
@Path("/{workspaceId}/executions")
@Produces("application/json")
ExecutionPage listExecutions(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @QueryParam("q")
 KeywordQuery q,
 @QueryParam("owner")
 AccountReference owner,
 @QueryParam("state")
 ExecutionState state,
 @QueryParam("limit") @Min(0L) @Max(100L) @DefaultValue("10")
 @Min(0L) @Max(100L) Integer limit,
 @QueryParam("cursor")
 ExecutionCursor cursor)

listWorkspaceSecrets

@GET
@Path("/{workspaceId}/secrets")
@Produces("application/json")
SecretPage listWorkspaceSecrets(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @QueryParam("q")
 KeywordQuery q,
 @QueryParam("owner")
 AccountReference owner,
 @QueryParam("limit") @Min(0L) @Max(100L) @DefaultValue("10")
 @Min(0L) @Max(100L) Integer limit,
 @QueryParam("cursor")
 SecretCursor cursor)

listWorkspaceTools

@GET
@Path("/{workspaceId}/tools")
@Produces({"application/json","application/problem+json"})
ToolPage listWorkspaceTools(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @QueryParam("q")
 KeywordQuery q,
 @QueryParam("owner")
 AccountReference owner,
 @QueryParam("order")
 ToolListOrdering order,
 @QueryParam("limit") @Min(0L) @Max(100L) @DefaultValue("10")
 @Min(0L) @Max(100L) Integer limit,
 @QueryParam("cursor")
 ToolCursor cursor)

listWorkspaces

@GET
@Produces("application/json")
WorkspacePage listWorkspaces(@QueryParam("q")
 KeywordQuery q,
 @QueryParam("owner")
 AccountReference owner,
 @QueryParam("limit") @Min(0L) @Max(100L) @DefaultValue("10")
 @Min(0L) @Max(100L) Integer limit,
 @QueryParam("cursor")
 WorkspaceCursor cursor)

transferExecution

@POST
@Path("/{workspaceId}/executions/{executionId}/transfer")
@Consumes("application/json")
@Produces({"application/json","application/problem+json"})
Execution transferExecution(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("executionId")
 ExecutionId executionId,
 @Valid
 @Valid ExecutionTransfer executionTransfer)

transferWorkspaceSecret

@POST
@Path("/{workspaceId}/secrets/{secretId}/transfer")
@Consumes("application/json")
@Produces({"application/json","application/problem+json"})
Secret transferWorkspaceSecret(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("secretId")
 SecretId secretId,
 @Valid
 @Valid SecretTransfer secretTransfer)

transferWorkspaceTool

@POST
@Path("/{workspaceId}/tools/{toolId}/transfer")
@Consumes("application/json")
@Produces({"application/json","application/problem+json"})
Tool transferWorkspaceTool(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("toolId")
 ToolId toolId,
 @Valid
 @Valid ToolTransfer toolTransfer)

updateExecution

@PATCH
@Path("/{workspaceId}/executions/{executionId}")
@Consumes("application/json")
@Produces({"application/json","application/problem+json"})
Execution updateExecution(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("executionId")
 ExecutionId executionId,
 @Valid
 @Valid ExecutionUpdate executionUpdate)

updateWorkspaceSecret

@PATCH
@Path("/{workspaceId}/secrets/{secretId}")
@Consumes("application/json")
@Produces({"application/json","application/problem+json"})
Secret updateWorkspaceSecret(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("secretId")
 SecretId secretId,
 @Valid
 @Valid SecretUpdate secretUpdate)

updateWorkspaceTool

@PATCH
@Path("/{workspaceId}/tools/{toolId}")
@Consumes("application/json")
@Produces({"application/json","application/problem+json"})
Tool updateWorkspaceTool(@PathParam("workspaceId")
 WorkspaceId workspaceId,
 @PathParam("toolId")
 ToolId toolId,
 @Valid
 @Valid ToolUpdate toolUpdate)