egg/PROJECT-CONTORL
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

spec: update api consistency

Browse Source 
Align optimistic locking conflict payload, update websocket docs, and adjust tests.
This commit is contained in:
beabigegg
2026-01-11 16:54:28 +08:00
parent f5f870da56
commit 2cb591ef23
9 changed files with 131 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
openspec/changes/update-api-consistency/proposal.md Normal file
View File

@@ -0,0 +1,14 @@
# 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.