settings_workdir_file_structure.py DOX

Purpose

Own the settings_workdir_file_structure.py API endpoint.
This module handles settings workdir file structure API requests.
Keep this file-level DOX profile synchronized with settings_workdir_file_structure.py because this directory is intentionally flat.

settings_workdir_file_structure.py owns the runtime implementation.
settings_workdir_file_structure.py.dox.md owns durable notes about responsibilities, contracts, side effects, and verification for that implementation.
Classes:
SettingsWorkdirFileStructure (ApiHandler)
- async process(self, input: dict, request: Request) -> dict | Response
- get_methods(cls) -> list[str]

HTTP handlers must derive from helpers.api.ApiHandler; WebSocket handlers must derive from helpers.ws.WsHandler.
Update this file whenever request payloads, authentication or CSRF requirements, response shapes, route side effects, or WebSocket event contracts change.
SettingsWorkdirFileStructure is an ApiHandler.
SettingsWorkdirFileStructure defines process(...).
SettingsWorkdirFileStructure defines get_methods(...).
Observed side-effect areas: filesystem reads, settings/state persistence.
Imported dependency areas include: helpers, helpers.api.

Important called helpers/classes observed in the source: files.get_abs_path_development, Exception, file_tree.file_tree.
Keep request/response, tool, or helper semantics documented here at the same time as source changes.

Preserve authentication, CSRF, loopback, and API-key checks unless the endpoint contract explicitly changes.
Update frontend callers, plugin callers, and tests together when payload shape changes.
Use helpers.api.Response for non-JSON responses, files, redirects, or status-specific replies.

Run endpoint-specific or API/WebSocket tests for changed behavior; smoke-test browser callers when no focused test exists.
No direct test reference was found by name search; choose the nearest behavioral test or perform a focused smoke check.

No child DOX files.