Skip to content

animals#

Animal models

AnimalsBase #

Bases: ZooModel

Animals model base

Source code in zoo/schemas/animals.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class AnimalsBase(ZooModel):
    """
    Animals model base
    """

    name: str = Field(description="The name of the animal")
    description: Optional[str] = Field(
        default=None, description="The description of the animal"
    )
    species: Optional[str] = Field(
        default=None, description="The species of the animal"
    )

    exhibit_id: Optional[int] = Field(description="The id of the exhibit", default=None)

    __example__: ClassVar[Dict[str, Any]] = {
        "name": "Lion",
        "description": "Ferocious kitty",
        "species": "Panthera leo",
        "exhibit_id": 1,
    }

AnimalsCreate #

Bases: AnimalsBase

Animals model: create

Source code in zoo/schemas/animals.py 
40
41
42
43
44
45
46
47
class AnimalsCreate(AnimalsBase):
    """
    Animals model: create
    """

    model_config = ConfigDict(
        json_schema_extra=AnimalsBase.get_openapi_create_example()
    )

AnimalsRead #

Bases: DeletedMixin, CreatedModifiedMixin, AnimalsBase, RequiredIdMixin

Animals model: read

Source code in zoo/schemas/animals.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
class AnimalsRead(
    DeletedMixin,
    CreatedModifiedMixin,
    AnimalsBase,
    RequiredIdMixin,
):
    """
    Animals model: read
    """

    model_config = ConfigDict(
        from_attributes=True,
        json_schema_extra=AnimalsBase.get_openapi_read_example(),
    )

AnimalsUpdate #

Bases: ZooModel

Animals model: update

Source code in zoo/schemas/animals.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
class AnimalsUpdate(ZooModel):
    """
    Animals model: update
    """

    name: Optional[str] = Field(default=None, description="The name of the animal")
    description: Optional[str] = Field(
        default=None, description="The description of the animal"
    )
    species: Optional[str] = Field(
        default=None, description="The species of the animal"
    )
    exhibit_id: Optional[int] = Field(description="The id of the exhibit", default=None)

    model_config = ConfigDict(
        json_schema_extra=AnimalsBase.get_openapi_update_example()
    )