mirror of
https://github.com/smittix/intercept.git
synced 2026-07-06 00:28:12 -07:00
James Smith
96172ca593
First-time run of ruff-format via pre-commit hook normalises quote style, trailing commas, and whitespace across 188 Python files. No logic changes. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
38 lines
1.1 KiB
Python
38 lines
1.1 KiB
Python
"""Standardized API response helpers.
|
|
|
|
Use these in new or modified routes for consistent JSON responses.
|
|
Existing routes are NOT being refactored to avoid unnecessary churn.
|
|
"""
|
|
|
|
from flask import jsonify
|
|
|
|
|
|
def api_success(data=None, message=None, status_code=200):
|
|
"""Return a success JSON response.
|
|
|
|
Args:
|
|
data: Optional dict of additional fields merged into the response.
|
|
message: Optional human-readable message.
|
|
status_code: HTTP status code (default 200).
|
|
"""
|
|
payload = {"status": "success"}
|
|
if message:
|
|
payload["message"] = message
|
|
if data:
|
|
payload.update(data)
|
|
return jsonify(payload), status_code
|
|
|
|
|
|
def api_error(message, status_code=400, error_type=None):
|
|
"""Return an error JSON response.
|
|
|
|
Args:
|
|
message: Human-readable error message.
|
|
status_code: HTTP status code (default 400).
|
|
error_type: Optional machine-readable error category (e.g. 'DEVICE_BUSY').
|
|
"""
|
|
payload = {"status": "error", "message": message}
|
|
if error_type:
|
|
payload["error_type"] = error_type
|
|
return jsonify(payload), status_code
|