Source code for airflow.providers.fab.auth_manager.schemas.role_and_permission_schema

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations

from typing import NamedTuple

from marshmallow import Schema, fields
from marshmallow_sqlalchemy import SQLAlchemySchema, auto_field

from airflow.providers.fab.auth_manager.models import Action, Permission, Resource, Role



[docs]
class ActionSchema(SQLAlchemySchema):
    """Action Schema."""


[docs]
    class Meta:
        """Meta."""


[docs]
        model = Action




[docs]
    name = auto_field()





[docs]
class ResourceSchema(SQLAlchemySchema):
    """View menu Schema."""


[docs]
    class Meta:
        """Meta."""


[docs]
        model = Resource




[docs]
    name = auto_field()





[docs]
class ActionCollection(NamedTuple):
    """Action Collection."""


[docs]
    actions: list[Action]


[docs]
    total_entries: int





[docs]
class ActionCollectionSchema(Schema):
    """Permissions list schema."""


[docs]
    actions = fields.List(fields.Nested(ActionSchema))


[docs]
    total_entries = fields.Int()





[docs]
class ActionResourceSchema(SQLAlchemySchema):
    """Action View Schema."""


[docs]
    class Meta:
        """Meta."""


[docs]
        model = Permission




[docs]
    action = fields.Nested(ActionSchema, data_key="action")


[docs]
    resource = fields.Nested(ResourceSchema, data_key="resource")





[docs]
class RoleSchema(SQLAlchemySchema):
    """Role item schema."""


[docs]
    class Meta:
        """Meta."""


[docs]
        model = Role




[docs]
    name = auto_field()


[docs]
    permissions = fields.List(fields.Nested(ActionResourceSchema), data_key="actions")





[docs]
class RoleCollection(NamedTuple):
    """List of roles."""


[docs]
    roles: list[Role]


[docs]
    total_entries: int





[docs]
class RoleCollectionSchema(Schema):
    """List of roles."""


[docs]
    roles = fields.List(fields.Nested(RoleSchema))


[docs]
    total_entries = fields.Int()





[docs]
role_schema = RoleSchema()


[docs]
role_collection_schema = RoleCollectionSchema()


[docs]
action_collection_schema = ActionCollectionSchema()