Packages
arke_server
0.1.34
0.5.1
0.5.0
0.4.3
0.4.2
0.4.1
0.4.0
0.4.0-bulk.0
0.3.18
0.3.17
0.3.16
0.3.15
0.3.14
0.3.13
0.3.12
0.3.11
0.3.10
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.1.42
0.1.41
0.1.40
0.1.39
0.1.38
0.1.37
0.1.36
0.1.35
0.1.34
0.1.33
0.1.32
0.1.31
0.1.30
0.1.29
0.1.28
0.1.27
0.1.26
0.1.25
0.1.24
0.1.23
0.1.22
0.1.21
0.1.20
0.1.19
0.1.18
0.1.17
0.1.16
0.1.15
0.1.14
0.1.13
0.1.12
0.1.11
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
Arke server
Current section
Files
Jump to
Current section
Files
lib/arke_server/controllers/topology_controller.ex
defmodule ArkeServer.TopologyController do
@moduledoc """
Documentation for `ArkeServer.TopologyController`.
""" && false
use ArkeServer, :controller
alias Arke.{QueryManager, LinkManager, StructManager}
alias Arke.Utils.ErrorGenerator, as: Error
alias UnitSerializer
alias ArkeServer.ResponseManager
alias ArkeServer.Utils.{QueryFilters, QueryOrder}
alias ArkeServer.Openapi.Responses
alias OpenApiSpex.{Operation, Reference}
# ------- start OPENAPI spec -------
def open_api_operation(action) do
operation = String.to_existing_atom("#{action}_operation")
apply(__MODULE__, operation, [])
end
def get_node_operation() do
%Operation{
tags: ["Topology"],
summary: "Get node",
description: "Get all elements (limited by depth parameter) linked to the given Unit",
operationId: "ArkeServer.TopologyController.get_node",
parameters: [
%Reference{"$ref": "#/components/parameters/arke_id"},
Operation.parameter(:arke_unit_id, :path, :string, "Parent Unit ID", required: true),
%Reference{"$ref": "#/components/parameters/link_id"},
Operation.parameter(:direction, :path, :string, "Direction where to get the node",
example: "child",
required: true
),
%Reference{"$ref": "#/components/parameters/arke-project-key"}
],
security: [%{"authorization" => []}],
responses: Responses.get_responses(201)
}
end
def create_node_operation() do
%Operation{
tags: ["Topology"],
summary: "Create connection",
description: "Create a link between two units",
operationId: "ArkeServer.TopologyController.create_node",
parameters: [
%Reference{"$ref": "#/components/parameters/arke_id"},
Operation.parameter(:arke_unit_id, :path, :string, "Parent Unit ID", required: true),
%Reference{"$ref": "#/components/parameters/link_id"},
Operation.parameter(:arke_id_two, :path, :string, "Child Arke ID", required: true),
Operation.parameter(:unit_id_two, :path, :string, "Child Arke ID", required: true),
%Reference{"$ref": "#/components/parameters/arke-project-key"}
],
security: [%{"authorization" => []}],
responses: Responses.get_responses()
}
end
def update_node_operation() do
%Operation{
tags: ["Topology"],
summary: "Update connection",
description: "Update link metadata between two units",
operationId: "ArkeServer.TopologyController.update_node(",
parameters: [
%Reference{"$ref": "#/components/parameters/arke_id"},
Operation.parameter(:arke_unit_id, :path, :string, "Parent Unit ID", required: true),
%Reference{"$ref": "#/components/parameters/link_id"},
Operation.parameter(:arke_id_two, :path, :string, "Child Arke ID", required: true),
Operation.parameter(:unit_id_two, :path, :string, "Child Arke ID", required: true),
%Reference{"$ref": "#/components/parameters/arke-project-key"}
],
security: [%{"authorization" => []}],
responses: Responses.get_responses([200])
}
end
def delete_node_operation() do
%Operation{
tags: ["Topology"],
summary: "Delete connection",
description: "Delete connection between two nodes",
operationId: "ArkeServer.TopologyController.delete_node",
parameters: [
Operation.parameter(:arke_id, :path, :string, "Parent Arke ID", required: true),
Operation.parameter(:arke_unit_id, :path, :string, "Parent Unit ID", required: true),
%Reference{"$ref": "#/components/parameters/link_id"},
Operation.parameter(:arke_id_two, :path, :string, "Child Arke ID", required: true),
Operation.parameter(:unit_id_two, :path, :string, "Child Unit ID", required: true),
%Reference{"$ref": "#/components/parameters/arke-project-key"}
],
security: [%{"authorization" => []}],
responses: Responses.get_responses([200, 201])
}
end
def add_parameter_operation() do
%Operation{
tags: ["Parameter"],
summary: "Add parameter",
description: "Add parameter to the given Arke",
operationId: "ArkeServer.TopologyController.add_parameter",
parameters: [
%Reference{"$ref": "#/components/parameters/arke_id"},
%Reference{"$ref": "#/components/parameters/arke_parameter_id"},
%Reference{"$ref": "#/components/parameters/arke-project-key"}
],
security: [%{"authorization" => []}],
responses: Responses.get_responses([200, 201])
}
end
def update_parameter_operation() do
%Operation{
tags: ["Parameter"],
summary: "Update associated parameter",
description: "Updates associated parameter of the given Arke",
operationId: "ArkeServer.TopologyController.update_parameter",
parameters: [
%Reference{"$ref": "#/components/parameters/arke_id"},
%Reference{"$ref": "#/components/parameters/arke_parameter_id"},
%Reference{"$ref": "#/components/parameters/arke-project-key"}
],
security: [%{"authorization" => []}],
responses: Responses.get_responses([200])
}
end
# ------- end OPENAPI spec -------
@doc """
Get the unit linked to an Arke
""" && false
def get_node(conn, %{"arke_id" => _arke_id, "arke_unit_id" => _id, "direction" => direction}) do
project = conn.assigns[:arke_project]
direction = String.to_existing_atom(direction)
depth = Map.get(conn.query_params, "depth", nil)
link_type = Map.get(conn.query_params, "link_type", nil)
offset = Map.get(conn.query_params, "offset", nil)
limit = Map.get(conn.query_params, "limit", nil)
order = Map.get(conn.query_params, "order", [])
# TODO handle query parameter with plugs
load_links = Map.get(conn.query_params, "load_links", "false") == "true"
load_values = Map.get(conn.query_params, "load_values", "false") == "true"
{count, units} =
QueryManager.query(project: project)
|> QueryManager.link(conn.assigns[:unit],
depth: depth,
direction: direction,
type: link_type
)
|> QueryFilters.apply_query_filters(Map.get(conn.assigns, :filter))
|> QueryOrder.apply_order(order)
|> QueryManager.pagination(offset, limit)
ResponseManager.send_resp(conn, 200, %{
count: count,
items:
StructManager.encode(units, load_links: load_links, load_values: load_values, type: :json)
})
end
@doc """
Link two unit together
""" && false
def create_node(%Plug.Conn{body_params: params} = conn, %{
"arke_id" => arke_id,
"arke_id_two" => arke_id_two,
"arke_unit_id" => parent_id,
"link_id" => type,
"unit_id_two" => child_id
}) do
project = conn.assigns[:arke_project]
# TODO handle query parameter with plugs
load_links = Map.get(conn.query_params, "load_links", "false") == "true"
load_values = Map.get(conn.query_params, "load_values", "false") == "true"
metadata = Map.get(params, "metadata", %{})
LinkManager.add_node(project, parent_id, child_id, type, metadata)
|> case do
{:ok, unit} ->
ResponseManager.send_resp(
conn,
201,
StructManager.encode(unit, load_links: load_links, load_values: load_values, type: :json)
)
{:error, error} ->
ResponseManager.send_resp(conn, 400, nil, error)
end
end
@doc """
Update metadata of an existing link
""" && false
def update_node(%Plug.Conn{body_params: params} = conn, %{
"arke_unit_id" => parent_id,
"link_id" => type,
"unit_id_two" => child_id
}) do
case Map.has_key?(params, "metadata") do
true ->
update_link(conn, parent_id, child_id, type, Map.get(params, "metadata"))
false ->
{:error, msg} = Error.create("link", "metadata is required")
ResponseManager.send_resp(conn, 400, nil, msg)
end
end
@doc """
Delete a connection between two units
""" && false
def delete_node(%Plug.Conn{body_params: params} = conn, %{
"arke_id" => _arke_id,
"arke_id_two" => _arke_id_two,
"arke_unit_id" => parent_id,
"link_id" => type,
"unit_id_two" => child_id
}) do
project = conn.assigns[:arke_project]
# link arke is only in :arke_system so it won't be changed right now
# link = ArkeManager.get :arke_link, :arke_system
metadata = Map.get(params, "metadata", %{})
with {:ok, nil} <- LinkManager.delete_node(project, parent_id, child_id, type, metadata) do
ResponseManager.send_resp(conn, 204)
else
{:error, error} ->
ResponseManager.send_resp(conn, 404, nil, error)
end
end
@doc """
Associate a parameter to an Arke
""" && false
def add_parameter(%Plug.Conn{body_params: params} = conn, %{
"arke_parameter_id" => parameter_id,
"arke_id" => arke_id
}) do
project = conn.assigns[:arke_project]
metadata = Map.get(params, "metadata", %{})
# TODO handle query parameter with plugs
load_links = Map.get(conn.query_params, "load_links", "false") == "true"
load_values = Map.get(conn.query_params, "load_values", "false") == "true"
LinkManager.add_node(project, arke_id, parameter_id, "parameter", metadata)
|> case do
{:ok, unit} ->
ResponseManager.send_resp(conn, 201, %{
content:
StructManager.encode(unit,
load_links: load_links,
load_values: load_values,
type: :json
)
})
{:error, error} ->
ResponseManager.send_resp(conn, 400, nil, error)
end
end
@doc """
Update an associated parameter of an Arke
""" && false
def update_parameter(%Plug.Conn{body_params: params} = conn, %{
"arke_parameter_id" => parameter_id,
"arke_id" => arke_id
}) do
case Map.has_key?(params, "metadata") do
true ->
update_link(conn, arke_id, parameter_id, "parameter", Map.get(params, "metadata"))
false ->
{:error, msg} = Error.create("link", "metadata is required")
ResponseManager.send_resp(conn, 400, nil, msg)
end
end
defp update_link(conn, arke_id, parameter_id, type, metadata) do
# TODO handle query parameter with plugs
# TODO improve checks if permissions are being touched
project = conn.assigns[:arke_project]
load_links = Map.get(conn.query_params, "load_links", "false") == "true"
load_values = Map.get(conn.query_params, "load_values", "false") == "true"
LinkManager.update_node(
project,
arke_id,
parameter_id,
type,
metadata
)
|> case do
{:ok, unit} ->
ResponseManager.send_resp(conn, 200, %{
content:
StructManager.encode(unit,
load_links: load_links,
load_values: load_values,
type: :json
)
})
{:error, error} ->
ResponseManager.send_resp(conn, 400, nil, error)
end
end
end