Files
PROJECT-CONTORL/openspec/changes/update-api-consistency/proposal.md
beabigegg 2cb591ef23 spec: update api consistency
Align optimistic locking conflict payload, update websocket docs, and adjust tests.
2026-01-11 16:54:28 +08:00

906 B

Change: Update API Consistency for WebSocket Auth, Workload Defaults, and Task Locking

Why

Several API behaviors are currently ambiguous or inconsistent (WebSocket auth handshake messaging, optimistic locking conflict payloads, and workload heatmap defaults). These gaps can confuse clients and reduce product completeness.

What Changes

  • Clarify WebSocket authentication error handling and client expectations.
  • Standardize optimistic locking conflict responses for task updates.
  • Define workload heatmap default inclusion rules and Sunday week-window behavior.
  • Align workload heatmap hide_empty defaults and caching behavior.

Impact

  • Affected specs: user-auth, task-management, resource-management
  • Affected code: backend WebSocket router, task update endpoint, workload service/router, workload cache; frontend workload views may require adjustments depending on default behavior.