"""
API operations on Group objects.
"""
import logging
from fastapi import Path
from galaxy.managers.context import ProvidesAppContext
from galaxy.managers.group_roles import GroupRolesManager
from galaxy.schema.fields import DecodedDatabaseIdField
from galaxy.schema.schema import (
GroupRoleListResponse,
GroupRoleResponse,
)
from galaxy.webapps.galaxy.api import (
depends,
DependsOnTrans,
Router,
)
log = logging.getLogger(__name__)
router = Router(tags=["group_roles"])
GroupIDParam: DecodedDatabaseIdField = Path(..., title="GroupID", description="The ID of the group")
RoleIDParam: DecodedDatabaseIdField = Path(..., title="RoleID", description="The ID of the role")
[docs]def group_role_to_model(trans, group_id: int, role) -> GroupRoleResponse:
encoded_group_id = DecodedDatabaseIdField.encode(group_id)
encoded_role_id = DecodedDatabaseIdField.encode(role.id)
url = trans.url_builder("group_role", group_id=encoded_group_id, role_id=encoded_role_id)
return GroupRoleResponse(id=role.id, name=role.name, url=url)
[docs]@router.cbv
class FastAPIGroupRoles:
manager: GroupRolesManager = depends(GroupRolesManager)
[docs] @router.get("/api/groups/{group_id}/roles", require_admin=True, summary="Displays a collection (list) of groups.")
def index(
self, trans: ProvidesAppContext = DependsOnTrans, group_id: DecodedDatabaseIdField = GroupIDParam
) -> GroupRoleListResponse:
group_roles = self.manager.index(trans, group_id)
return GroupRoleListResponse(__root__=[group_role_to_model(trans, group_id, gr.role) for gr in group_roles])
[docs] @router.get(
"/api/groups/{group_id}/roles/{role_id}",
name="group_role",
require_admin=True,
summary="Displays information about a group role.",
)
def show(
self,
trans: ProvidesAppContext = DependsOnTrans,
group_id: DecodedDatabaseIdField = GroupIDParam,
role_id: DecodedDatabaseIdField = RoleIDParam,
) -> GroupRoleResponse:
role = self.manager.show(trans, role_id, group_id)
return group_role_to_model(trans, group_id, role)
[docs] @router.put("/api/groups/{group_id}/roles/{role_id}", require_admin=True, summary="Adds a role to a group")
def update(
self,
trans: ProvidesAppContext = DependsOnTrans,
group_id: DecodedDatabaseIdField = GroupIDParam,
role_id: DecodedDatabaseIdField = RoleIDParam,
) -> GroupRoleResponse:
role = self.manager.update(trans, role_id, group_id)
return group_role_to_model(trans, group_id, role)
[docs] @router.delete("/api/groups/{group_id}/roles/{role_id}", require_admin=True, summary="Removes a role from a group")
def delete(
self,
trans: ProvidesAppContext = DependsOnTrans,
group_id: DecodedDatabaseIdField = GroupIDParam,
role_id: DecodedDatabaseIdField = RoleIDParam,
) -> GroupRoleResponse:
role = self.manager.delete(trans, role_id, group_id)
return group_role_to_model(trans, group_id, role)