OpenCode.Generated.Workspace (opencode_sdk v0.1.55)

Copy Markdown View Source

Provides API endpoints related to workspace

Summary

Types

experimental_workspace_adapter_list_200_json_resp()
experimental_workspace_session_restore_200_json_resp()
experimental_workspace_status_200_json_resp()
t()

Functions

experimental_workspace_adapter_list(opts \\ [])

List workspace adapters

experimental_workspace_create(body, opts \\ [])

Create workspace

experimental_workspace_list(opts \\ [])

List workspaces

experimental_workspace_remove(id, opts \\ [])

Remove workspace

experimental_workspace_session_restore(id, body, opts \\ [])

Restore session into workspace

experimental_workspace_status(opts \\ [])

Workspace status

Types

experimental_workspace_adapter_list_200_json_resp()

@type experimental_workspace_adapter_list_200_json_resp() :: %{
  description: String.t(),
  name: String.t(),
  type: String.t()
}

experimental_workspace_session_restore_200_json_resp()

@type experimental_workspace_session_restore_200_json_resp() :: %{total: integer()}

experimental_workspace_status_200_json_resp()

@type experimental_workspace_status_200_json_resp() :: %{
  status: String.t(),
  workspace_id: String.t()
}

t()

@type t() :: %OpenCode.Generated.Workspace{
  branch: String.t() | nil,
  directory: String.t() | nil,
  extra: map() | nil,
  id: String.t(),
  name: String.t(),
  project_id: String.t(),
  type: String.t()
}

Functions

experimental_workspace_adapter_list(opts \\ [])

@spec experimental_workspace_adapter_list(opts :: keyword()) ::
  {:ok, [experimental_workspace_adapter_list_200_json_resp()]} | :error

List workspace adapters

List all available workspace adapters for the current project.

Options

  • directory
  • workspace

experimental_workspace_create(body, opts \\ [])

@spec experimental_workspace_create(body :: map(), opts :: keyword()) ::
  {:ok, t()} | {:error, OpenCode.Generated.BadRequestError.t()}

Create workspace

Create a workspace for the current project.

Options

  • directory
  • workspace

Request Body

Content Types: application/json

experimental_workspace_list(opts \\ [])

@spec experimental_workspace_list(opts :: keyword()) :: {:ok, [t()]} | :error

List workspaces

List all workspaces.

Options

  • directory
  • workspace

experimental_workspace_remove(id, opts \\ [])

@spec experimental_workspace_remove(id :: String.t(), opts :: keyword()) ::
  {:ok, t()} | {:error, OpenCode.Generated.BadRequestError.t()}

Remove workspace

Remove an existing workspace.

Options

  • directory
  • workspace

experimental_workspace_session_restore(id, body, opts \\ [])

@spec experimental_workspace_session_restore(
  id :: String.t(),
  body :: map(),
  opts :: keyword()
) ::
  {:ok, experimental_workspace_session_restore_200_json_resp()}
  | {:error, OpenCode.Generated.BadRequestError.t()}

Restore session into workspace

Replay a session's sync events into the target workspace in batches.

Options

  • directory
  • workspace

Request Body

Content Types: application/json

experimental_workspace_status(opts \\ [])

@spec experimental_workspace_status(opts :: keyword()) ::
  {:ok, [experimental_workspace_status_200_json_resp()]} | :error

Workspace status

Get connection status for workspaces in the current project.

Options

  • directory
  • workspace