Miosa.Workspaces (Miosa v1.0.1)

Manage MIOSA workspaces.

A workspace groups one or more computers under a shared project boundary. Workspaces are identified by an ID and carry a display name and optional metadata. Every computer belongs to exactly one workspace.

Example

client = Miosa.client("msk_u_...")

{:ok, ws} = Miosa.Workspaces.create(client, %{name: "my-project"})
{:ok, workspaces} = Miosa.Workspaces.list(client)
{:ok, ws} = Miosa.Workspaces.get(client, ws.id)
{:ok, ws} = Miosa.Workspaces.update(client, ws.id, %{name: "renamed"})
{:ok, computers} = Miosa.Workspaces.list_computers(client, ws.id)
:ok = Miosa.Workspaces.delete(client, ws.id)

Summary

Types

create_params()

update_params()

Functions

create(client, params)

Creates a new workspace.

delete(client, id)

Deletes a workspace.

get(client, id)

Fetches a single workspace by ID.

list(client)

Lists all workspaces for the authenticated tenant.

list_computers(client, workspace_id)

Lists all computers belonging to a workspace.

update(client, id, params)

Updates a workspace's attributes.

Types

create_params()

@type create_params() :: %{:name => String.t(), optional(:metadata) => map()}

update_params()

@type update_params() :: %{
  optional(:name) => String.t(),
  optional(:metadata) => map()
}

Functions

create(client, params)

@spec create(Miosa.Client.t(), create_params()) ::
  Miosa.Client.result(Miosa.Types.Workspace.t())

Creates a new workspace.

Params

:name — Required. Display name for the workspace.
:metadata — Optional. Arbitrary key-value map.

delete(client, id)

@spec delete(Miosa.Client.t(), String.t()) :: :ok | {:error, Miosa.Error.t()}

Deletes a workspace.

All computers in the workspace must be stopped or destroyed before deletion, or the API will return a 409 conflict.

get(client, id)

@spec get(Miosa.Client.t(), String.t()) ::
  Miosa.Client.result(Miosa.Types.Workspace.t())

Fetches a single workspace by ID.

list(client)

@spec list(Miosa.Client.t()) :: Miosa.Client.result([Miosa.Types.Workspace.t()])

Lists all workspaces for the authenticated tenant.

list_computers(client, workspace_id)

@spec list_computers(Miosa.Client.t(), String.t()) ::
  Miosa.Client.result([Miosa.Types.Computer.t()])

Lists all computers belonging to a workspace.

update(client, id, params)

@spec update(Miosa.Client.t(), String.t(), update_params()) ::
  Miosa.Client.result(Miosa.Types.Workspace.t())

Updates a workspace's attributes.

Only the supplied fields are updated (PATCH semantics).