flowdeck/app/models/responses.py

"""FlowDeck — Standardized response models."""
from __future__ import annotations

from typing import Any

from pydantic import BaseModel


class ErrorResponse(BaseModel):
    """Standardized error response.

    Example:
        ErrorResponse(error="Rate limit exceeded", detail="Max 100 req/min per IP")
    """
    error: str
    detail: str | None = None

    model_config = {
        "json_schema_extra": {
            "example": {"error": "Not found", "detail": "Board not found"}
        }
    }


class SuccessResponse(BaseModel):
    """Standardized success response.

    Example:
        SuccessResponse(status="ok", data={"issue_id": 42})
    """
    status: str = "ok"
    data: dict[str, Any] | None = None

    model_config = {
        "json_schema_extra": {
            "example": {"status": "ok", "data": {"issue_id": 42, "column": "Done"}}
        }
    }