This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

Source code for galaxy.webapps.galaxy.api.roles

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 (
from galaxy.webapps.base.controller import url_for
from galaxy.webapps.galaxy.api import (

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") role_id = DecodedDatabaseIdField.encode(role.id) item["url"] = url_for("role", id=role_id) return RoleModelResponse(**item)
[docs]@router.cbv class FastAPIRoles: role_manager: RoleManager = depends(RoleManager)
[docs] @router.get("/api/roles") def index(self, trans: ProvidesUserContext = DependsOnTrans) -> RoleListResponse: roles = self.role_manager.list_displayable_roles(trans) return RoleListResponse(__root__=[role_to_model(r) for r in roles])
[docs] @router.get("/api/roles/{id}") def show(self, id: DecodedDatabaseIdField, trans: ProvidesUserContext = DependsOnTrans) -> RoleModelResponse: 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(...) ) -> RoleModelResponse: role = self.role_manager.create_role(trans, role_definition_model) return role_to_model(role)