Files
PROJECT-CONTORL/openspec/changes/archive/2026-01-10-add-api-enhancements/tasks.md
beabigegg 3bdc6ff1c9 feat: implement 8 OpenSpec proposals for security, reliability, and UX improvements
## Security Enhancements (P0)
- Add input validation with max_length and numeric range constraints
- Implement WebSocket token authentication via first message
- Add path traversal prevention in file storage service

## Permission Enhancements (P0)
- Add project member management for cross-department access
- Implement is_department_manager flag for workload visibility

## Cycle Detection (P0)
- Add DFS-based cycle detection for task dependencies
- Add formula field circular reference detection
- Display user-friendly cycle path visualization

## Concurrency & Reliability (P1)
- Implement optimistic locking with version field (409 Conflict on mismatch)
- Add trigger retry mechanism with exponential backoff (1s, 2s, 4s)
- Implement cascade restore for soft-deleted tasks

## Rate Limiting (P1)
- Add tiered rate limits: standard (60/min), sensitive (20/min), heavy (5/min)
- Apply rate limits to tasks, reports, attachments, and comments

## Frontend Improvements (P1)
- Add responsive sidebar with hamburger menu for mobile
- Improve touch-friendly UI with proper tap target sizes
- Complete i18n translations for all components

## Backend Reliability (P2)
- Configure database connection pool (size=10, overflow=20)
- Add Redis fallback mechanism with message queue
- Add blocker check before task deletion

## API Enhancements (P3)
- Add standardized response wrapper utility
- Add /health/ready and /health/live endpoints
- Implement project templates with status/field copying

## Tests Added
- test_input_validation.py - Schema and path traversal tests
- test_concurrency_reliability.py - Optimistic locking and retry tests
- test_backend_reliability.py - Connection pool and Redis tests
- test_api_enhancements.py - Health check and template tests

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-10 22:13:43 +08:00

1.4 KiB

Tasks: Add API Enhancements

1. API Response Standardization

  • 1.1 Create response wrapper utility class
  • 1.2 Define standard response structure {success, data, message, timestamp}
  • 1.3 Create error response format with error_code field
  • 1.4 Apply wrapper to sample endpoints for validation (deferred - breaking change, use incrementally)
  • 1.5 Document response format in API docs (documented in code comments)

2. API Versioning

  • 2.1 Add /api/v1/ prefix to all routes
  • 2.2 Update frontend API base URL configuration
  • 2.3 Keep /api/ routes as alias during transition
  • 2.4 Add deprecation headers to old routes

3. Enhanced Health Check

  • 3.1 Add database connectivity check
  • 3.2 Add Redis connectivity check
  • 3.3 Add scheduler status check
  • 3.4 Return detailed status object with check results
  • 3.5 Add /health/ready and /health/live endpoints

4. Project Templates

  • 4.1 Create ProjectTemplate model with fields
  • 4.2 Create database migration
  • 4.3 Add template CRUD API endpoints
  • 4.4 Implement "create project from template" endpoint
  • 4.5 Copy TaskStatus and CustomField definitions from template
  • 4.6 Add frontend template selection in project creation

5. Testing

  • 5.1 Test standardized response format
  • 5.2 Test API version routing
  • 5.3 Test enhanced health check scenarios
  • 5.4 Test project template creation flow