Skip to content

settings

create_setting(payload)

Create a new setting in the database

Source code in cat/routes/settings.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
@router.post("/")
def create_setting(payload: models.SettingBody):
    """Create a new setting in the database"""

    # complete the payload with setting_id and updated_at
    payload = models.Setting(**payload.model_dump())

    # save to DB
    new_setting = crud.create_setting(payload)

    return {
        "setting": new_setting
    }

delete_setting(settingId)

Delete a specific setting in the database

Source code in cat/routes/settings.py 
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
@router.delete("/{settingId}")
def delete_setting(settingId: str):
    """Delete a specific setting in the database"""

    # does the setting exist?
    setting = crud.get_setting_by_id(settingId)
    if not setting:
        raise HTTPException(
            status_code = 404,
            detail = {
                "error": f"No setting with this id: {settingId}",
            },
        )

    # delete
    crud.delete_setting_by_id(settingId)

    return {
        "deleted": settingId
    }

get_setting(settingId)

Get the a specific setting from the database

Source code in cat/routes/settings.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
@router.get("/{settingId}")
def get_setting(settingId: str):
    """Get the a specific setting from the database"""

    setting = crud.get_setting_by_id(settingId)
    if not setting:
        raise HTTPException(
            status_code = 404,
            detail = {
                "error": f"No setting with this id: {settingId}",
            },
        )
    return {
        "setting": setting
    }

get_settings(search='')

Get the entire list of settings available in the database

Source code in cat/routes/settings.py 
10
11
12
13
14
15
16
17
18
@router.get("/")
def get_settings(search: str = ""):
    """Get the entire list of settings available in the database"""

    settings = crud.get_settings(search=search)

    return {
        "settings": settings
    }

update_setting(settingId, payload)

Update a specific setting in the database if it exists

Source code in cat/routes/settings.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
@router.put("/{settingId}")
def update_setting(settingId: str, payload: models.SettingBody):
    """Update a specific setting in the database if it exists"""

    # does the setting exist?
    setting = crud.get_setting_by_id(settingId)
    if not setting:
        raise HTTPException(
            status_code = 404,
            detail = {
                "error": f"No setting with this id: {settingId}",
            },
        )

    # complete the payload with setting_id and updated_at
    payload = models.Setting(**payload.model_dump())
    payload.setting_id = settingId # force this to be the setting_id

    # save to DB
    updated_setting = crud.update_setting_by_id(payload)

    return {
        "setting": updated_setting
    }