Skip to content

staff#

Exhibits models

StaffBase #

Bases: ZooModel

Staff model base

Source code in zoo/schemas/staff.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class StaffBase(ZooModel):
    """
    Staff model base
    """

    name: str = Field(description="The name of the staff")
    job_title: Optional[str] = Field(
        default=None, description="The job title of the staff"
    )
    email: Optional[EmailStr] = Field(
        default=None, description="The email of the staff"
    )
    phone: Optional[str] = Field(
        default=None, description="The phone number of the staff"
    )
    notes: Optional[str] = Field(
        default=None, description="Optional notes regarding the staff member"
    )
    exhibit_id: Optional[int] = Field(description="The id of the exhibit", default=None)

    __example__: ClassVar[Dict[str, Any]] = {
        "name": "John Doe",
        "job_title": "Zookeeper",
        "email": "[email protected]",
        "phone": "555-555-5555",
        "notes": "John Doe is a great zookeeper and loves cats!",
        "exhibit_id": 1,
    }

StaffCreate #

Bases: StaffBase

Staff model: create

Source code in zoo/schemas/staff.py 
47
48
49
50
51
52
class StaffCreate(StaffBase):
    """
    Staff model: create
    """

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

StaffRead #

Bases: DeletedMixin, CreatedModifiedMixin, StaffBase, RequiredIdMixin

Staff model: read

Source code in zoo/schemas/staff.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
class StaffRead(
    DeletedMixin,
    CreatedModifiedMixin,
    StaffBase,
    RequiredIdMixin,
):
    """
    Staff model: read
    """

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

StaffUpdate #

Bases: ZooModel

Staff model: update

Source code in zoo/schemas/staff.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
class StaffUpdate(ZooModel):
    """
    Staff model: update
    """

    name: Optional[str] = Field(default=None, description="The name of the staff")
    job_title: Optional[str] = Field(
        default=None, description="The job title of the staff"
    )
    email: Optional[EmailStr] = Field(
        default=None, description="The email of the staff"
    )
    phone: Optional[str] = Field(
        default=None, description="The phone number of the staff"
    )
    notes: Optional[str] = Field(
        default=None, description="Optional notes regarding the staff member"
    )
    exhibit_id: Optional[int] = Field(description="The id of the exhibit", default=None)

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