docs: add docstrings to all API endpoints and daemon handlers
Add comprehensive docstrings to firewall, DHCP, proxy, wireguard, certs, and logs API endpoints. Document parameters, return values, and error cases for the documentation system.
This commit is contained in:
+73
-5
@@ -21,7 +21,11 @@ class NotFound(Exception):
|
||||
|
||||
|
||||
class BadRequest(Exception):
|
||||
"""Raised when the daemon returns HTTP 400."""
|
||||
"""Exception raised when the daemon returns HTTP 400.
|
||||
|
||||
Used to signal client-side input or formatting errors from the
|
||||
daemon for distinction from general failures.
|
||||
"""
|
||||
|
||||
pass
|
||||
|
||||
@@ -30,6 +34,15 @@ _DEFAULT_SOCKET = None
|
||||
|
||||
|
||||
def _get_socket_path() -> str:
|
||||
"""Return the daemon Unix socket path.
|
||||
|
||||
Lazily resolves the path from the VACUUM_WALLD_SOCKET environment
|
||||
variable or falls back to data/daemon.sock under the project
|
||||
directory. The result is cached in _DEFAULT_SOCKET.
|
||||
|
||||
Returns:
|
||||
Absolute path string for the daemon socket.
|
||||
"""
|
||||
global _DEFAULT_SOCKET
|
||||
if _DEFAULT_SOCKET is None:
|
||||
import os
|
||||
@@ -44,6 +57,13 @@ def _get_socket_path() -> str:
|
||||
|
||||
|
||||
def set_socket_path(path: str) -> None:
|
||||
"""Override the default daemon socket path.
|
||||
|
||||
Useful for tests that need an alternate socket.
|
||||
|
||||
Args:
|
||||
path: Absolute path to the Unix socket file.
|
||||
"""
|
||||
global _DEFAULT_SOCKET
|
||||
_DEFAULT_SOCKET = path
|
||||
|
||||
@@ -110,22 +130,70 @@ def request(
|
||||
|
||||
|
||||
def get(path: str, params: dict[str, Any] | None = None, **kwargs: Any) -> Any:
|
||||
"""GET request to daemon. Params are sent as URL query parameters."""
|
||||
"""Send a GET request to the daemon.
|
||||
|
||||
Query parameters are passed as URL params rather than a JSON body.
|
||||
Additional keyword arguments are forwarded to request().
|
||||
|
||||
Args:
|
||||
path: URL path to request on the daemon.
|
||||
params: Optional query parameters to append to the URL.
|
||||
**kwargs: Extra arguments forwarded to request().
|
||||
|
||||
Returns:
|
||||
The parsed JSON response data from the daemon.
|
||||
"""
|
||||
return request("GET", path, query_params=params, **kwargs)
|
||||
|
||||
|
||||
def post(path: str, body: dict[str, Any] | None = None, **kwargs: Any) -> Any:
|
||||
"""POST request to daemon."""
|
||||
"""Send a POST request to the daemon.
|
||||
|
||||
The body is transmitted as a JSON payload. Extra keyword arguments
|
||||
are forwarded to request().
|
||||
|
||||
Args:
|
||||
path: URL path to request on the daemon.
|
||||
body: Optional JSON-serializable payload.
|
||||
**kwargs: Extra arguments forwarded to request().
|
||||
|
||||
Returns:
|
||||
The parsed JSON response data from the daemon.
|
||||
"""
|
||||
return request("POST", path, json_body=body, **kwargs)
|
||||
|
||||
|
||||
def patch(path: str, body: dict[str, Any] | None = None, **kwargs: Any) -> Any:
|
||||
"""PATCH request to daemon."""
|
||||
"""Send a PATCH request to the daemon.
|
||||
|
||||
The body is transmitted as a JSON payload. Extra keyword arguments
|
||||
are forwarded to request().
|
||||
|
||||
Args:
|
||||
path: URL path to request on the daemon.
|
||||
body: Optional JSON-serializable payload.
|
||||
**kwargs: Extra arguments forwarded to request().
|
||||
|
||||
Returns:
|
||||
The parsed JSON response data from the daemon.
|
||||
"""
|
||||
return request("PATCH", path, json_body=body, **kwargs)
|
||||
|
||||
|
||||
def delete(path: str, body: dict[str, Any] | None = None, **kwargs: Any) -> Any:
|
||||
"""DELETE request to daemon."""
|
||||
"""Send a DELETE request to the daemon.
|
||||
|
||||
The body is transmitted as a JSON payload. Extra keyword arguments
|
||||
are forwarded to request().
|
||||
|
||||
Args:
|
||||
path: URL path to request on the daemon.
|
||||
body: Optional JSON-serializable payload.
|
||||
**kwargs: Extra arguments forwarded to request().
|
||||
|
||||
Returns:
|
||||
The parsed JSON response data from the daemon.
|
||||
"""
|
||||
return request("DELETE", path, json_body=body, **kwargs)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user