Miosa.Community (Miosa v1.0.0)

Community template and agent catalog with install and rate actions.

Routes live under /api/v1/community/ and require a JWT.

Summary

Functions

get_agent(client, agent_id)

Get a community agent by ID (GET /community/agents/:agent_id).

get_template(client, template_id)

Get a community template by ID (GET /community/templates/:template_id).

install_template(client, template_id, opts \\ %{})

Install a community template into the caller's tenant (POST /community/templates/:template_id/install).

list_agents(client, filters \\ %{})

List community agents (GET /community/agents).

list_templates(client, filters \\ %{})

List community templates (GET /community/templates).

rate_template(client, template_id, rating, opts \\ %{})

Rate a community template 1-5 (POST /community/templates/:template_id/rate).

Functions

get_agent(client, agent_id)

@spec get_agent(Miosa.Client.t(), String.t()) :: Miosa.Client.result(map())

Get a community agent by ID (GET /community/agents/:agent_id).

get_template(client, template_id)

@spec get_template(Miosa.Client.t(), String.t()) :: Miosa.Client.result(map())

Get a community template by ID (GET /community/templates/:template_id).

install_template(client, template_id, opts \\ %{})

@spec install_template(Miosa.Client.t(), String.t(), map()) ::
  Miosa.Client.result(map())

Install a community template into the caller's tenant (POST /community/templates/:template_id/install).

list_agents(client, filters \\ %{})

@spec list_agents(Miosa.Client.t(), map()) :: Miosa.Client.result(list())

List community agents (GET /community/agents).

Accepts optional filter params.

list_templates(client, filters \\ %{})

@spec list_templates(Miosa.Client.t(), map()) :: Miosa.Client.result(list())

List community templates (GET /community/templates).

Accepts optional filter params.

rate_template(client, template_id, rating, opts \\ %{})

@spec rate_template(Miosa.Client.t(), String.t(), 1..5, map()) ::
  Miosa.Client.result(map())

Rate a community template 1-5 (POST /community/templates/:template_id/rate).