Module: type_hierarchy_request

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed 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 cl.runtime.routers.schema.type_request import TypeRequest


class TypeHierarchyRequest(TypeRequest):
    """Request data type for the /schema/type-hierarchy route."""

    return_ancestors: bool = False
    """If true, type ancestors will be returned with the specified type."""

Classes

class TypeHierarchyRequest (**data: Any)

Request data type for the /schema/type-hierarchy route.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Expand source code

class TypeHierarchyRequest(TypeRequest):
    """Request data type for the /schema/type-hierarchy route."""

    return_ancestors: bool = False
    """If true, type ancestors will be returned with the specified type."""

Ancestors

TypeRequest
UserRequest
pydantic.main.BaseModel

Class variables

var model_computed_fields
var model_config
var model_fields
var module: Inherited from: TypeRequest.module

Dot-delimited module string.
var name: Inherited from: TypeRequest.name

Class name.
var return_ancestors: If true, type ancestors will be returned with the specified type.
var user: Inherited from: TypeRequest.user

User identifier or identity token