#232 OpenAPI: Utility & System Endpoints (13 endpoints)

closed low Created 2025-12-02 08:16 · Updated 2025-12-02 09:11

Description

Edit
## Scope Document utility and system endpoints: - `api/blueprints/v1/health.py` (2 endpoints) - `api/blueprints/v1/statistics.py` (2 endpoints) - `api/blueprints/v1/idempotency.py` (2 endpoints) - `api/blueprints/v1/dsl_templates.py` (2 endpoints) - `api/blueprints/v1/dsl_converter.py` (1 endpoint) - `api/blueprints/v1/version.py` (1 endpoint) - `api/blueprints/v1/tenants.py` (1 endpoint) - `api/blueprints/v1/queries.py` (1 endpoint) - `api/blueprints/v1/monitoring.py` (1 endpoint) ## Health Endpoints (2) 1. GET /health - Health check 2. GET /health/detailed - Detailed health check ## Statistics Endpoints (2) 1. GET /statistics - System statistics 2. GET /statistics/detailed - Detailed stats ## Idempotency Endpoints (2) 1. GET /idempotency/{key} - Check idempotency key 2. DELETE /idempotency/{key} - Clear idempotency key ## DSL Templates Endpoints (2) 1. GET /dsl-templates - List templates 2. GET /dsl-templates/{name} - Get template ## DSL Converter Endpoint (1) 1. POST /dsl/convert - Convert Python DSL to JSON ## Version Endpoint (1) 1. GET /version - Get API version ## Tenants Endpoint (1) 1. GET /tenants/current - Get current tenant info ## Queries Endpoint (1) 1. GET /workflows/{id}/query - Query workflow state ## Monitoring Endpoint (1) 1. GET /metrics - Prometheus metrics ## Pydantic Models ```python class HealthResponse(BaseModel): status: str # healthy, degraded, unhealthy version: str uptime_seconds: int class DetailedHealthResponse(HealthResponse): database: str redis: str workers: int queue_depth: int class SystemStatistics(BaseModel): total_workflows: int running_workflows: int completed_today: int failed_today: int avg_duration_ms: float class VersionInfo(BaseModel): version: str build_date: str git_commit: str ``` ## Depends On - #224 (Infrastructure Setup) ## Acceptance Criteria - [ ] All 13 endpoints documented - [ ] Health check response codes documented - [ ] Prometheus format documented

Comments

Loading comments...

Context

Loading context...

Audit History

View All
Loading audit history...