Skip to content

fastack.models

DetailModel (GenericModel, Generic) pydantic-model

Schema to define data details in OpenAPI (for Controller.json method)

Source code in fastack/models.py 
class DetailModel(GenericModel, Generic[GenericDataType]):
    """
    Schema to define data details in OpenAPI (for ``Controller.json`` method)
    """

    detail: Optional[str]
    data: Optional[GenericDataType]

PaginatedModel (GenericModel, Generic) pydantic-model

Schema for paged data (for ListController.get_paginated_response method)

Source code in fastack/models.py 
class PaginatedModel(GenericModel, Generic[GenericDataType]):
    """
    Schema for paged data (for ``ListController.get_paginated_response`` method)
    """

    total: Optional[int]
    paging: PagingModel
    data: List[GenericDataType]

PagingModel (BaseModel) pydantic-model

Schema for part of paging field in PaginatedModel.

Source code in fastack/models.py 
class PagingModel(BaseModel):
    """
    Schema for part of ``paging`` field in ``PaginatedModel``.
    """

    next: Optional[int]
    prev: Optional[int]
    pages: List[int]
Last update: January 17, 2022 13:26:42