Skip to content

errors

ErrorModel

Bases: BaseModel

Represents an error model containing details of an error.

This class is used to encapsulate metadata for error conditions, such as the error code and the error message. It provides a structured way to convey error information within applications or across systems.

Attributes:

Name Type Description
code int

Error code for the error.
message str

Error message for the error.
Source code in backend/app/errors/model.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
class ErrorModel(BaseModel):
    """
    Represents an error model containing details of an error.

    This class is used to encapsulate metadata for error conditions, such as
    the error code and the error message. It provides a structured way to
    convey error information within applications or across systems.

    :ivar code: Error code for the error.
    :type code: int
    :ivar message: Error message for the error.
    :type message: str
    """
    code: int = Field(
        description="Error code for the error.",
    )
    message: str = Field(
        description="Error message for the error.",
    )