Refactor: Add legacy V2 support to modern object definitions and document V3 architecture.
This commit is contained in:
Scott Idem
@@ -27,6 +27,12 @@ async def health_check(
|
||||
):
|
||||
"""
|
||||
Health check endpoint for V3 API.
|
||||
|
||||
Architectural Choices:
|
||||
- Non-blocking delay: Uses 'await asyncio.sleep' instead of 'time.sleep' to prevent
|
||||
blocking the event loop, ensuring the Gunicorn worker can handle other requests.
|
||||
- Granular Dependencies: Uses 'DelayParams' to handle optional latency simulation
|
||||
consistently across all V3 endpoints via headers (X-Delay-ms) or query params (delay_ms).
|
||||
"""
|
||||
if delay.sleep_time_s > 0:
|
||||
await asyncio.sleep(delay.sleep_time_s)
|
||||
@@ -47,9 +53,12 @@ async def get_obj(
|
||||
):
|
||||
"""
|
||||
Get a single top-level object by its random ID.
|
||||
Examples:
|
||||
- /v3/crud/journal/{journal_id}
|
||||
- /v3/crud/account/{account_id}
|
||||
|
||||
Special Cases:
|
||||
- Object Resolution: Random IDs (id_random) are resolved to internal integer IDs
|
||||
using Redis for performance, falling back to SQL if not found.
|
||||
- Consistency: Uses 'obj_type_kv_li' from ae_obj_types_def.py to map URL paths
|
||||
to database views/tables and Pydantic models.
|
||||
"""
|
||||
if delay.sleep_time_s > 0:
|
||||
await asyncio.sleep(delay.sleep_time_s)
|
||||
@@ -95,10 +104,13 @@ async def get_obj_li(
|
||||
):
|
||||
"""
|
||||
Get a list of top-level objects.
|
||||
Examples:
|
||||
- /v3/crud/journal/
|
||||
- /v3/crud/journal/?for_obj_type=account&for_obj_id={account_id_random}
|
||||
- /v3/crud/journal/?jp={"qry":[{"type":"AND","field":"for_type","operator":"=","value":"user"},{"type":"AND","field":"for_id","operator":"=","value":<user_id>}]}
|
||||
|
||||
Features:
|
||||
- Status Filtering: Automatically filters by 'enabled' and 'hidden' status using
|
||||
the StatusFilterParams dependency.
|
||||
- Flexible Querying: Supports complex JSON-based queries via the 'jp' parameter.
|
||||
- Contextual Filtering: Optionally filters by parent object relationship if
|
||||
'for_obj_type' and 'for_obj_id' are provided.
|
||||
"""
|
||||
if delay.sleep_time_s > 0:
|
||||
await asyncio.sleep(delay.sleep_time_s)
|
||||
@@ -213,8 +225,10 @@ async def post_obj(
|
||||
):
|
||||
"""
|
||||
Create a new top-level object.
|
||||
Examples:
|
||||
- POST /v3/crud/journal/ (with Journal_Base in body)
|
||||
|
||||
Validation:
|
||||
- Uses 'mdl_in' from the object configuration to strictly validate incoming JSON data.
|
||||
- 'data_to_insert' excludes unset fields to allow database defaults to apply.
|
||||
"""
|
||||
if delay.sleep_time_s > 0:
|
||||
await asyncio.sleep(delay.sleep_time_s)
|
||||
@@ -263,6 +277,539 @@ async def post_obj(
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message="Failed to create object in database.")
|
||||
|
||||
|
||||
@router.patch('/{obj_type_l1}/{obj_id}', response_model=Resp_Body_Base)
|
||||
async def patch_obj(
|
||||
request: Request,
|
||||
response: Response,
|
||||
obj_type_l1: str = Path(min_length=2, max_length=50),
|
||||
obj_id: str = Path(min_length=11, max_length=22),
|
||||
return_obj: Optional[bool] = True,
|
||||
account: AccountContext = Depends(get_account_context),
|
||||
serialization: SerializationParams = Depends(get_serialization_params),
|
||||
delay: DelayParams = Depends(get_delay_params),
|
||||
):
|
||||
"""
|
||||
Update a top-level object.
|
||||
|
||||
Behavior:
|
||||
- Partial Updates: Unlike POST, PATCH does not perform strict full-model validation,
|
||||
allowing partial updates of only the fields provided in the body.
|
||||
"""
|
||||
if delay.sleep_time_s > 0:
|
||||
await asyncio.sleep(delay.sleep_time_s)
|
||||
|
||||
log.setLevel(logging.WARNING)
|
||||
log.debug(locals())
|
||||
|
||||
obj_data = await request.json()
|
||||
|
||||
obj_name = obj_type_l1
|
||||
if obj_name not in obj_type_kv_li:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Object type '{obj_name}' not found.")
|
||||
|
||||
obj_cfg = obj_type_kv_li[obj_name]
|
||||
table_name_update = obj_cfg.get('tbl_update', obj_cfg.get('tbl'))
|
||||
table_name_select = obj_cfg.get('tbl_default', obj_cfg.get('tbl'))
|
||||
input_model = obj_cfg.get('mdl_in', obj_cfg.get('mdl'))
|
||||
output_model = obj_cfg.get('mdl_out', obj_cfg.get('mdl_default', obj_cfg.get('mdl')))
|
||||
|
||||
if not table_name_update or not input_model or not table_name_select or not output_model:
|
||||
return mk_resp(data=False, status_code=500, response=response, status_message=f"Configuration for object type '{obj_name}' is incomplete.")
|
||||
|
||||
record_id = redis_lookup_id_random(record_id_random=obj_id, table_name=obj_name)
|
||||
if not record_id:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Object with ID '{obj_id}' not found.")
|
||||
|
||||
# Validate incoming data with the appropriate Pydantic model.
|
||||
# For PATCH, we don't want to fail on missing fields, so we don't validate like in POST.
|
||||
# The sql_update function will only update the fields provided in the dict.
|
||||
data_to_update = obj_data
|
||||
|
||||
if sql_update_result := sql_update(data=data_to_update, table_name=table_name_update, record_id=record_id):
|
||||
|
||||
if return_obj:
|
||||
if sql_select_result := sql_select(table_name=table_name_select, record_id=record_id):
|
||||
resp_data = output_model(**sql_select_result).dict(by_alias=serialization.by_alias, exclude_unset=serialization.exclude_unset)
|
||||
return mk_resp(data=resp_data, response=response)
|
||||
else:
|
||||
return mk_resp(data=True, status_code=404, response=response, status_message="Object updated but could not be retrieved.")
|
||||
else:
|
||||
return mk_resp(data=True, response=response, status_message="Object updated successfully.")
|
||||
else:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message="Failed to update object in database. It may not have been found, or the data was invalid.")
|
||||
|
||||
|
||||
@router.delete('/{obj_type_l1}/{obj_id}', response_model=Resp_Body_Base)
|
||||
async def delete_obj(
|
||||
response: Response,
|
||||
obj_type_l1: str = Path(min_length=2, max_length=50),
|
||||
obj_id: str = Path(min_length=11, max_length=22),
|
||||
account: AccountContext = Depends(get_account_context),
|
||||
delay: DelayParams = Depends(get_delay_params),
|
||||
):
|
||||
"""
|
||||
Delete a top-level object.
|
||||
|
||||
Soft Delete:
|
||||
- Note that 'sql_delete' may implement soft-delete behavior depending on the
|
||||
'method' query parameter (delete, disable, hide), matching legacy behavior.
|
||||
"""
|
||||
if delay.sleep_time_s > 0:
|
||||
await asyncio.sleep(delay.sleep_time_s)
|
||||
|
||||
log.setLevel(logging.WARNING)
|
||||
log.debug(locals())
|
||||
|
||||
obj_name = obj_type_l1
|
||||
if obj_name not in obj_type_kv_li:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Object type '{obj_name}' not found.")
|
||||
|
||||
obj_cfg = obj_type_kv_li[obj_name]
|
||||
table_name_delete = obj_cfg.get('tbl_update', obj_cfg.get('tbl'))
|
||||
|
||||
if not table_name_delete:
|
||||
return mk_resp(data=False, status_code=500, response=response, status_message=f"Configuration for object type '{obj_name}' is incomplete (missing table for deletion).")
|
||||
|
||||
record_id = redis_lookup_id_random(record_id_random=obj_id, table_name=obj_name)
|
||||
if not record_id:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Object with ID '{obj_id}' not found.")
|
||||
|
||||
if sql_delete_result := sql_delete(table_name=table_name_delete, record_id=record_id):
|
||||
return mk_resp(data=True, response=response, status_message=f"Object with ID '{obj_id}' deleted successfully.")
|
||||
else:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message="Failed to delete object in database. It may not have been found.")
|
||||
|
||||
|
||||
@router.get('/{parent_obj_type}/{parent_obj_id}/{child_obj_type}/', response_model=Resp_Body_Base)
|
||||
async def get_child_obj_li(
|
||||
response: Response,
|
||||
parent_obj_type: str,
|
||||
parent_obj_id: str,
|
||||
child_obj_type: str,
|
||||
order_by_li: Optional[str] = None,
|
||||
jp: Optional[Union[str, None]] = None,
|
||||
account: AccountContext = Depends(get_account_context),
|
||||
pagination: PaginationParams = Depends(get_pagination_params),
|
||||
status_filter: StatusFilterParams = Depends(get_status_filter_params),
|
||||
serialization: SerializationParams = Depends(get_serialization_params),
|
||||
delay: DelayParams = Depends(get_delay_params),
|
||||
):
|
||||
"""
|
||||
Get a list of child objects belonging to a parent.
|
||||
|
||||
Nested URL Logic:
|
||||
- This enforces parentage by using the parent's ID from the URL to filter the child list.
|
||||
- Convention: Assumes the child table has a foreign key field named '{parent_obj_type}_id'.
|
||||
"""
|
||||
if delay.sleep_time_s > 0:
|
||||
await asyncio.sleep(delay.sleep_time_s)
|
||||
|
||||
log.setLevel(logging.WARNING)
|
||||
log.debug(locals())
|
||||
|
||||
# This function's logic is very similar to get_obj_li,
|
||||
# but it enforces the parent-child relationship from the URL path.
|
||||
# We can treat the parent path parameters as if they were for_obj_type and for_obj_id query params.
|
||||
|
||||
for_obj_type = parent_obj_type
|
||||
for_obj_id = parent_obj_id
|
||||
|
||||
qry_dict_li = None
|
||||
fulltext_qry_dict_obj = None
|
||||
and_qry_dict_obj = None
|
||||
and_like_dict_obj = None
|
||||
or_like_dict_obj = None
|
||||
and_in_dict_li_obj = None
|
||||
jp_obj = None
|
||||
|
||||
if jp:
|
||||
try:
|
||||
jp_obj = json.loads(urllib.parse.unquote(jp))
|
||||
except Exception as e:
|
||||
log.warning(e)
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message='The JSON string was not formatted correctly.')
|
||||
|
||||
if jp_obj.get('qry'):
|
||||
qry_dict_li = jp_obj['qry']
|
||||
if jp_obj.get('ft_qry'):
|
||||
fulltext_qry_dict_obj = jp_obj['ft_qry']
|
||||
if jp_obj.get('and_qry'):
|
||||
and_qry_dict_obj = jp_obj['and_qry']
|
||||
if jp_obj.get('and_like'):
|
||||
and_like_dict_obj = jp_obj['and_like']
|
||||
if jp_obj.get('or_like'):
|
||||
or_like_dict_obj = jp_obj['or_like']
|
||||
if jp_obj.get('and_in_li'):
|
||||
and_in_dict_li_obj = jp_obj['and_in_li']
|
||||
|
||||
if order_by_li:
|
||||
order_by_li = json.loads(order_by_li)
|
||||
|
||||
obj_name = child_obj_type
|
||||
if obj_name not in obj_type_kv_li:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Object type '{obj_name}' not found.")
|
||||
|
||||
obj_cfg = obj_type_kv_li[obj_name]
|
||||
table_name = obj_cfg.get('tbl_default', obj_cfg.get('tbl'))
|
||||
base_name = obj_cfg.get('mdl_default', obj_cfg.get('mdl'))
|
||||
|
||||
if not table_name or not base_name:
|
||||
return mk_resp(data=False, status_code=500, response=response, status_message=f"Configuration for object type '{obj_name}' is incomplete.")
|
||||
|
||||
# Resolve parent's random ID to integer ID
|
||||
resolved_parent_id = redis_lookup_id_random(record_id_random=for_obj_id, table_name=for_obj_type)
|
||||
if not resolved_parent_id:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Parent object '{for_obj_type}' with ID '{for_obj_id}' not found.")
|
||||
|
||||
field_name = f'{for_obj_type}_id' # Assuming convention like 'journal_id'
|
||||
|
||||
sql_result = sql_select(
|
||||
table_name=table_name,
|
||||
field_name=field_name,
|
||||
field_value=resolved_parent_id,
|
||||
enabled=status_filter.enabled,
|
||||
hidden=status_filter.hidden,
|
||||
qry_dict_li=qry_dict_li,
|
||||
fulltext_qry_dict=fulltext_qry_dict_obj,
|
||||
and_qry_dict=and_qry_dict_obj,
|
||||
and_like_dict=and_like_dict_obj,
|
||||
or_like_dict=or_like_dict_obj,
|
||||
and_in_dict_li=and_in_dict_li_obj,
|
||||
order_by_li=order_by_li,
|
||||
limit=pagination.limit,
|
||||
offset=pagination.offset,
|
||||
as_list=True,
|
||||
)
|
||||
|
||||
if sql_result:
|
||||
resp_data_li = []
|
||||
for record in sql_result:
|
||||
resp_data = base_name(**record).dict(by_alias=serialization.by_alias, exclude_unset=serialization.exclude_unset)
|
||||
resp_data_li.append(resp_data)
|
||||
return mk_resp(data=resp_data_li, response=response)
|
||||
else:
|
||||
return mk_resp(data=[], status_code=200, response=response) # Return empty list on no results
|
||||
|
||||
|
||||
@router.post('/{parent_obj_type}/{parent_obj_id}/{child_obj_type}/', response_model=Resp_Body_Base)
|
||||
async def post_child_obj(
|
||||
request: Request,
|
||||
response: Response,
|
||||
parent_obj_type: str = Path(min_length=2, max_length=50),
|
||||
parent_obj_id: str = Path(min_length=11, max_length=22),
|
||||
child_obj_type: str = Path(min_length=2, max_length=50),
|
||||
return_obj: Optional[bool] = True,
|
||||
account: AccountContext = Depends(get_account_context),
|
||||
serialization: SerializationParams = Depends(get_serialization_params),
|
||||
delay: DelayParams = Depends(get_delay_params),
|
||||
):
|
||||
"""
|
||||
Create a new child object for a given parent.
|
||||
|
||||
Logic:
|
||||
- Auto-injection: Automatically resolves the parent's random ID and injects the
|
||||
integer ID into the child's data before validation and insertion.
|
||||
"""
|
||||
if delay.sleep_time_s > 0:
|
||||
await asyncio.sleep(delay.sleep_time_s)
|
||||
|
||||
log.setLevel(logging.WARNING)
|
||||
log.debug(locals())
|
||||
|
||||
obj_data = await request.json()
|
||||
|
||||
parent_obj_name = parent_obj_type
|
||||
child_obj_name = child_obj_type
|
||||
|
||||
if parent_obj_name not in obj_type_kv_li:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Parent object type '{parent_obj_name}' not found.")
|
||||
if child_obj_name not in obj_type_kv_li:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Child object type '{child_obj_name}' not found.")
|
||||
|
||||
resolved_parent_id = redis_lookup_id_random(record_id_random=parent_obj_id, table_name=parent_obj_name)
|
||||
if not resolved_parent_id:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Parent object '{parent_obj_name}' with ID '{parent_obj_id}' not found.")
|
||||
|
||||
obj_cfg = obj_type_kv_li[child_obj_name]
|
||||
table_name_insert = obj_cfg.get('tbl_update', obj_cfg.get('tbl'))
|
||||
table_name_select = obj_cfg.get('tbl_default', obj_cfg.get('tbl'))
|
||||
input_model = obj_cfg.get('mdl_in', obj_cfg.get('mdl'))
|
||||
output_model = obj_cfg.get('mdl_out', obj_cfg.get('mdl_default', obj_cfg.get('mdl')))
|
||||
|
||||
if not table_name_insert or not input_model or not table_name_select or not output_model:
|
||||
return mk_resp(data=False, status_code=500, response=response, status_message=f"Configuration for child object type '{child_obj_name}' is incomplete.")
|
||||
|
||||
# Inject the parent ID into the child object's data
|
||||
parent_fk_field_name = f'{parent_obj_name}_id'
|
||||
obj_data[parent_fk_field_name] = resolved_parent_id
|
||||
|
||||
# Validate incoming data with the appropriate Pydantic model
|
||||
try:
|
||||
validated_obj = input_model(**obj_data)
|
||||
except Exception as e:
|
||||
log.warning(f"Validation error for {child_obj_name}: {e}")
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Validation error: {e}")
|
||||
|
||||
# Convert to dict, excluding unset fields, for database insertion
|
||||
data_to_insert = validated_obj.dict(exclude_unset=True)
|
||||
|
||||
if sql_insert_result := sql_insert(data=data_to_insert, table_name=table_name_insert):
|
||||
new_obj_id = sql_insert_result
|
||||
new_obj_id_random = get_id_random(record_id=new_obj_id, table_name=child_obj_name)
|
||||
|
||||
if return_obj:
|
||||
if sql_select_result := sql_select(table_name=table_name_select, record_id=new_obj_id):
|
||||
resp_data = output_model(**sql_select_result).dict(by_alias=serialization.by_alias, exclude_unset=serialization.exclude_unset)
|
||||
return mk_resp(data=resp_data, response=response)
|
||||
else:
|
||||
return mk_resp(data={"obj_id": new_obj_id, "obj_id_random": new_obj_id_random}, status_code=404, response=response, status_message="Child object created but could not be retrieved.")
|
||||
else:
|
||||
return mk_resp(data={"obj_id": new_obj_id, "obj_id_random": new_obj_id_random}, response=response)
|
||||
else:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message="Failed to create child object in database.")
|
||||
|
||||
|
||||
@router.get('/{parent_obj_type}/{parent_obj_id}/{child_obj_type}/{child_obj_id}', response_model=Resp_Body_Base)
|
||||
async def get_child_obj(
|
||||
response: Response,
|
||||
parent_obj_type: str = Path(min_length=2, max_length=50),
|
||||
parent_obj_id: str = Path(min_length=11, max_length=22),
|
||||
child_obj_type: str = Path(min_length=2, max_length=50),
|
||||
child_obj_id: str = Path(min_length=11, max_length=22),
|
||||
account: AccountContext = Depends(get_account_context),
|
||||
serialization: SerializationParams = Depends(get_serialization_params),
|
||||
delay: DelayParams = Depends(get_delay_params),
|
||||
):
|
||||
"""
|
||||
Get a single child object by its ID, ensuring it belongs to the correct parent.
|
||||
|
||||
Security:
|
||||
- Verifies that the child object's foreign key correctly points to the parent
|
||||
provided in the URL, preventing access to unrelated child objects.
|
||||
"""
|
||||
if delay.sleep_time_s > 0:
|
||||
await asyncio.sleep(delay.sleep_time_s)
|
||||
|
||||
log.setLevel(logging.WARNING)
|
||||
log.debug(locals())
|
||||
|
||||
parent_obj_name = parent_obj_type
|
||||
child_obj_name = child_obj_type
|
||||
|
||||
if parent_obj_name not in obj_type_kv_li:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Parent object type '{parent_obj_name}' not found.")
|
||||
if child_obj_name not in obj_type_kv_li:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Child object type '{child_obj_name}' not found.")
|
||||
|
||||
resolved_parent_id = redis_lookup_id_random(record_id_random=parent_obj_id, table_name=parent_obj_name)
|
||||
if not resolved_parent_id:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Parent object '{parent_obj_name}' with ID '{parent_obj_id}' not found.")
|
||||
|
||||
obj_cfg = obj_type_kv_li[child_obj_name]
|
||||
table_name = obj_cfg.get('tbl_default', obj_cfg.get('tbl'))
|
||||
base_name = obj_cfg.get('mdl_default', obj_cfg.get('mdl'))
|
||||
|
||||
if not table_name or not base_name:
|
||||
return mk_resp(data=False, status_code=500, response=response, status_message=f"Configuration for object type '{child_obj_name}' is incomplete.")
|
||||
|
||||
resolved_child_id = redis_lookup_id_random(record_id_random=child_obj_id, table_name=child_obj_name)
|
||||
if not resolved_child_id:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Child object with ID '{child_obj_id}' not found.")
|
||||
|
||||
if sql_result := sql_select(table_name=table_name, record_id=resolved_child_id):
|
||||
# Verify the child belongs to the parent
|
||||
parent_fk_field_name = f'{parent_obj_name}_id'
|
||||
if sql_result.get(parent_fk_field_name) != resolved_parent_id:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Child object '{child_obj_id}' not found under parent '{parent_obj_id}'.")
|
||||
|
||||
resp_data = base_name(**sql_result).dict(by_alias=serialization.by_alias, exclude_unset=serialization.exclude_unset)
|
||||
return mk_resp(data=resp_data, response=response)
|
||||
else:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Child object with ID '{child_obj_id}' not found in database.")
|
||||
|
||||
|
||||
@router.patch('/{parent_obj_type}/{parent_obj_id}/{child_obj_type}/{child_obj_id}', response_model=Resp_Body_Base)
|
||||
async def patch_child_obj(
|
||||
request: Request,
|
||||
response: Response,
|
||||
parent_obj_type: str = Path(min_length=2, max_length=50),
|
||||
parent_obj_id: str = Path(min_length=11, max_length=22),
|
||||
child_obj_type: str = Path(min_length=2, max_length=50),
|
||||
child_obj_id: str = Path(min_length=11, max_length=22),
|
||||
return_obj: Optional[bool] = True,
|
||||
account: AccountContext = Depends(get_account_context),
|
||||
serialization: SerializationParams = Depends(get_serialization_params),
|
||||
delay: DelayParams = Depends(get_delay_params),
|
||||
):
|
||||
"""
|
||||
Update a child object by its ID, ensuring it belongs to the correct parent.
|
||||
|
||||
Verification:
|
||||
- Like GET, PATCH verifies parentage before applying any updates to ensure data integrity.
|
||||
"""
|
||||
if delay.sleep_time_s > 0:
|
||||
await asyncio.sleep(delay.sleep_time_s)
|
||||
|
||||
log.setLevel(logging.WARNING)
|
||||
log.debug(locals())
|
||||
|
||||
obj_data = await request.json()
|
||||
|
||||
parent_obj_name = parent_obj_type
|
||||
child_obj_name = child_obj_type
|
||||
|
||||
if parent_obj_name not in obj_type_kv_li:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Parent object type '{parent_obj_name}' not found.")
|
||||
if child_obj_name not in obj_type_kv_li:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Child object type '{child_obj_name}' not found.")
|
||||
|
||||
# Resolve IDs
|
||||
resolved_parent_id = redis_lookup_id_random(record_id_random=parent_obj_id, table_name=parent_obj_name)
|
||||
if not resolved_parent_id:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Parent object '{parent_obj_name}' with ID '{parent_obj_id}' not found.")
|
||||
|
||||
resolved_child_id = redis_lookup_id_random(record_id_random=child_obj_id, table_name=child_obj_name)
|
||||
if not resolved_child_id:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Child object '{child_obj_name}' with ID '{child_obj_id}' not found.")
|
||||
|
||||
# Get config for child object
|
||||
obj_cfg = obj_type_kv_li[child_obj_name]
|
||||
table_name_update = obj_cfg.get('tbl_update', obj_cfg.get('tbl'))
|
||||
table_name_select = obj_cfg.get('tbl_default', obj_cfg.get('tbl'))
|
||||
output_model = obj_cfg.get('mdl_out', obj_cfg.get('mdl_default', obj_cfg.get('mdl')))
|
||||
|
||||
if not table_name_update or not table_name_select or not output_model:
|
||||
return mk_resp(data=False, status_code=500, response=response, status_message=f"Configuration for child object type '{child_obj_name}' is incomplete.")
|
||||
|
||||
# Verify parentage before updating
|
||||
if existing_child := sql_select(table_name=table_name_select, record_id=resolved_child_id):
|
||||
parent_fk_field_name = f'{parent_obj_name}_id'
|
||||
if existing_child.get(parent_fk_field_name) != resolved_parent_id:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Child object '{child_obj_id}' not found under parent '{parent_obj_id}'.")
|
||||
else:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Child object '{child_obj_id}' not found.")
|
||||
|
||||
# The sql_update function will only update the fields provided in the dict.
|
||||
data_to_update = obj_data
|
||||
|
||||
if sql_update(data=data_to_update, table_name=table_name_update, record_id=resolved_child_id):
|
||||
if return_obj:
|
||||
if updated_child := sql_select(table_name=table_name_select, record_id=resolved_child_id):
|
||||
resp_data = output_model(**updated_child).dict(by_alias=serialization.by_alias, exclude_unset=serialization.exclude_unset)
|
||||
return mk_resp(data=resp_data, response=response)
|
||||
else:
|
||||
return mk_resp(data=True, status_code=404, response=response, status_message="Object updated but could not be retrieved post-update.")
|
||||
else:
|
||||
return mk_resp(data=True, response=response, status_message="Object updated successfully.")
|
||||
else:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message="Failed to update object in database.")
|
||||
|
||||
|
||||
@router.delete('/{parent_obj_type}/{parent_obj_id}/{child_obj_type}/{child_obj_id}', response_model=Resp_Body_Base)
|
||||
async def delete_child_obj(
|
||||
response: Response,
|
||||
parent_obj_type: str = Path(min_length=2, max_length=50),
|
||||
parent_obj_id: str = Path(min_length=11, max_length=22),
|
||||
child_obj_type: str = Path(min_length=2, max_length=50),
|
||||
child_obj_id: str = Path(min_length=11, max_length=22),
|
||||
account: AccountContext = Depends(get_account_context),
|
||||
delay: DelayParams = Depends(get_delay_params),
|
||||
):
|
||||
"""
|
||||
Delete a child object by its ID, ensuring it belongs to the correct parent.
|
||||
|
||||
Safety:
|
||||
- Enforces parentage verification before deletion to prevent unauthorized data removal.
|
||||
"""
|
||||
if delay.sleep_time_s > 0:
|
||||
await asyncio.sleep(delay.sleep_time_s)
|
||||
|
||||
log.setLevel(logging.WARNING)
|
||||
log.debug(locals())
|
||||
|
||||
parent_obj_name = parent_obj_type
|
||||
child_obj_name = child_obj_type
|
||||
|
||||
if parent_obj_name not in obj_type_kv_li:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Parent object type '{parent_obj_name}' not found.")
|
||||
if child_obj_name not in obj_type_kv_li:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Child object type '{child_obj_name}' not found.")
|
||||
|
||||
# Resolve IDs
|
||||
resolved_parent_id = redis_lookup_id_random(record_id_random=parent_obj_id, table_name=parent_obj_name)
|
||||
if not resolved_parent_id:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Parent object '{parent_obj_name}' with ID '{parent_obj_id}' not found.")
|
||||
|
||||
resolved_child_id = redis_lookup_id_random(record_id_random=child_obj_id, table_name=child_obj_name)
|
||||
if not resolved_child_id:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Child object '{child_obj_name}' with ID '{child_obj_id}' not found.")
|
||||
|
||||
# Get config for child object
|
||||
obj_cfg = obj_type_kv_li[child_obj_name]
|
||||
table_name_delete = obj_cfg.get('tbl_update', obj_cfg.get('tbl'))
|
||||
table_name_select = obj_cfg.get('tbl_default', obj_cfg.get('tbl')) # For verification
|
||||
|
||||
if not table_name_delete or not table_name_select:
|
||||
return mk_resp(data=False, status_code=500, response=response, status_message=f"Configuration for child object type '{child_obj_name}' is incomplete.")
|
||||
|
||||
# Verify parentage before deleting
|
||||
if existing_child := sql_select(table_name=table_name_select, record_id=resolved_child_id):
|
||||
parent_fk_field_name = f'{parent_obj_name}_id'
|
||||
if existing_child.get(parent_fk_field_name) != resolved_parent_id:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Child object '{child_obj_id}' not found under parent '{parent_obj_id}'.")
|
||||
else:
|
||||
return mk_resp(data=False, status_code=404, response=response, status_message=f"Child object '{child_obj_id}' not found.")
|
||||
|
||||
# If verification passes, delete the object
|
||||
if sql_delete(table_name=table_name_delete, record_id=resolved_child_id):
|
||||
return mk_resp(data=True, response=response, status_message=f"Object with ID '{child_obj_id}' deleted successfully.")
|
||||
else:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message="Failed to delete object in database.")
|
||||
|
||||
log.setLevel(logging.WARNING)
|
||||
log.debug(locals())
|
||||
|
||||
obj_data = await request.json()
|
||||
|
||||
obj_name = obj_type_l1
|
||||
if obj_name not in obj_type_kv_li:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Object type '{obj_name}' not found.")
|
||||
|
||||
obj_cfg = obj_type_kv_li[obj_name]
|
||||
table_name_insert = obj_cfg.get('tbl_update', obj_cfg.get('tbl'))
|
||||
table_name_select = obj_cfg.get('tbl_default', obj_cfg.get('tbl'))
|
||||
input_model = obj_cfg.get('mdl_in', obj_cfg.get('mdl'))
|
||||
output_model = obj_cfg.get('mdl_out', obj_cfg.get('mdl_default', obj_cfg.get('mdl')))
|
||||
|
||||
if not table_name_insert or not input_model or not table_name_select or not output_model:
|
||||
return mk_resp(data=False, status_code=500, response=response, status_message=f"Configuration for object type '{obj_name}' is incomplete.")
|
||||
|
||||
# Validate incoming data with the appropriate Pydantic model
|
||||
try:
|
||||
validated_obj = input_model(**obj_data)
|
||||
except Exception as e:
|
||||
log.warning(f"Validation error for {obj_name}: {e}")
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message=f"Validation error: {e}")
|
||||
|
||||
# Convert to dict, excluding unset fields, for database insertion
|
||||
data_to_insert = validated_obj.dict(exclude_unset=True)
|
||||
|
||||
if sql_insert_result := sql_insert(data=data_to_insert, table_name=table_name_insert):
|
||||
new_obj_id = sql_insert_result
|
||||
new_obj_id_random = get_id_random(record_id=new_obj_id, table_name=obj_name)
|
||||
|
||||
if return_obj:
|
||||
if sql_select_result := sql_select(table_name=table_name_select, record_id=new_obj_id):
|
||||
resp_data = output_model(**sql_select_result).dict(by_alias=serialization.by_alias, exclude_unset=serialization.exclude_unset)
|
||||
return mk_resp(data=resp_data, response=response)
|
||||
else:
|
||||
return mk_resp(data={"obj_id": new_obj_id, "obj_id_random": new_obj_id_random}, status_code=404, response=response, status_message="Object created but could not be retrieved.")
|
||||
else:
|
||||
return mk_resp(data={"obj_id": new_obj_id, "obj_id_random": new_obj_id_random}, response=response)
|
||||
else:
|
||||
return mk_resp(data=False, status_code=400, response=response, status_message="Failed to create object in database.")
|
||||
|
||||
|
||||
@router.patch('/{obj_type_l1}/{obj_id}', response_model=Resp_Body_Base)
|
||||
async def patch_obj(
|
||||
request: Request,
|
||||
|
||||
Reference in New Issue
Block a user