Folder API - davidmarsoni/llog GitHub Wiki
APIs specifically for creating, renaming, deleting, and listing folders used to organize cached items.
-
/files/folders/create-folder- Creates a new folder -
/files/folders/rename-folder- Renames an existing folder -
/files/folders/get-folders- API endpoint to retrieve the list of all existing folders -
/files/folders/delete-folder- Deletes a folder (contents moved to parent folder) -
/files/folders/refresh- Endpoint to manually trigger a refresh of the folder cache
Creates a new folder.
QUERY: POST /files/folders/create-folder
ARGS (Form Data):
- folder_name: Name of the new folder.
- parent_path: (Optional) Path of the parent folder (empty for root).
ARGS (Query Parameters for redirect):
- page, per_page, filter_title, filter_type: To preserve view state.
RETURN: Redirects to `/files/view` targeting the parent folder (or root). Flashes success or error message.
Renames an existing folder.
QUERY: POST /files/folders/rename-folder
ARGS (Form Data):
- folder_path: The current path of the folder to rename.
- new_name: The new name for the folder.
ARGS (Query Parameters for redirect):
- page, per_page, filter_title, filter_type: To preserve view state.
RETURN: Redirects to `/files/view` targeting the parent folder (or root). Flashes success or error message.
API endpoint to retrieve the list of all existing folders.
QUERY: GET /files/folders/get-folders
RETURN: JSON response:
- folders: A list of folder objects.
- error: (Optional) Error message if retrieval failed.
Deletes a folder. Contents are moved to the parent folder.
QUERY: POST /files/folders/delete-folder
ARGS (Form Data):
- folder_path: The path of the folder to delete.
ARGS (Query Parameters for redirect):
- page, per_page, filter_title, filter_type: To preserve view state.
RETURN: Redirects to `/files/view` targeting the parent folder (or root). Flashes success or error message including the number of items moved.
Endpoint to manually trigger a refresh of the folder cache (if applicable).
QUERY: POST /files/folders/refresh
RETURN: JSON response:
- message: Success message.
- error: (Optional) Error message if refresh failed.