"""
API operations on Role objects.
"""
import logging
from fastapi import Body
from galaxy.managers.context import ProvidesUserContext
from galaxy.managers.roles import RoleManager
from galaxy.schema.fields import DecodedDatabaseIdField
from galaxy.schema.schema import (
RoleDefinitionModel,
RoleListModel,
RoleModel,
)
from galaxy.webapps.base.controller import url_for
from galaxy.webapps.galaxy.api import (
depends,
DependsOnTrans,
Router,
)
log = logging.getLogger(__name__)
# Empty paths (e.g. /api/roles) only work if a prefix is defined right here.
# https://github.com/tiangolo/fastapi/pull/415/files
router = Router(tags=["roles"])
[docs]def role_to_model(role):
item = role.to_dict(view="element", value_mapper={"id": DecodedDatabaseIdField.encode})
role_id = DecodedDatabaseIdField.encode(role.id)
item["url"] = url_for("role", id=role_id)
return RoleModel.construct(**item)
[docs]@router.cbv
class FastAPIRoles:
role_manager: RoleManager = depends(RoleManager)
[docs] @router.get("/api/roles")
def index(self, trans: ProvidesUserContext = DependsOnTrans) -> RoleListModel:
roles = self.role_manager.list_displayable_roles(trans)
return RoleListModel(__root__=[role_to_model(r) for r in roles])
[docs] @router.get("/api/roles/{id}")
def show(self, id: DecodedDatabaseIdField, trans: ProvidesUserContext = DependsOnTrans) -> RoleModel:
role = self.role_manager.get(trans, id)
return role_to_model(role)
[docs] @router.post("/api/roles", require_admin=True)
def create(
self, trans: ProvidesUserContext = DependsOnTrans, role_definition_model: RoleDefinitionModel = Body(...)
) -> RoleModel:
role = self.role_manager.create_role(trans, role_definition_model)
return role_to_model(role)