Area: documentation
Page or file: docs/api.md lines 890-893 (sort_by description)
What should be improved?
After the sort_by downgrade fix is merged (see https://github.com/Fearvox/EverOS/pull/new/proofstorm/r2-sort-override-observable), the agent_skill table's lack of a timestamp column is no longer 'silently handled': the manager downgrades the request to updated_at, the response's GetData.effective_sort echoes the actual column, and a structlog warning (get.sort_by.downgraded) is emitted on every override.
The current text in docs/api.md still says: 'for memory_type values where "timestamp" does not apply (e.g. "profile" has no timestamp, "agent_skill" is a named entity), the server silently falls back to "updated_at".'' That sentence is now misleading — there is no longer a silent fallback; the override is observable in three ways (DTO echo, log event, request diff).
The docs flip is included in the same PR — this issue exists to record the contract change for anyone reviewing the docs surface separately, and to ensure future audits catch any reversion.
Steps to reproduce
- Open
docs/api.md at the /api/v1/memory/get endpoint section.
- Locate the
sort_by parameter description (around line 890).
- Observe: text still describes the old 'silently falls back' contract.
- Compare with the new behavior in the same PR:
effective_sort echo, get.sort_by.downgraded log line, no silent fallback.
Expected vs actual
- Expected: docs say 'downgraded' (not 'silently'), reference the
effective_sort DTO echo, and mention the structured log event.
- Actual: docs say 'silently falls back' (the old contract).
Environment
- Repo: EverMind-AI/EverOS
- File: docs/api.md (lines 890-893)
- Renderer: GitHub Markdown
The fix is in the same PR (https://github.com/Fearvox/EverOS/pull/new/proofstorm/r2-sort-override-observable). This issue is filed so the contract change is discoverable in the docs audit trail.
Area: documentation
Page or file:
docs/api.mdlines 890-893 (sort_by description)What should be improved?
After the sort_by downgrade fix is merged (see https://github.com/Fearvox/EverOS/pull/new/proofstorm/r2-sort-override-observable), the
agent_skilltable's lack of atimestampcolumn is no longer 'silently handled': the manager downgrades the request toupdated_at, the response'sGetData.effective_sortechoes the actual column, and a structlog warning (get.sort_by.downgraded) is emitted on every override.The current text in
docs/api.mdstill says: 'formemory_typevalues where"timestamp"does not apply (e.g."profile"has no timestamp,"agent_skill"is a named entity), the server silently falls back to"updated_at".'' That sentence is now misleading — there is no longer a silent fallback; the override is observable in three ways (DTO echo, log event, request diff).The docs flip is included in the same PR — this issue exists to record the contract change for anyone reviewing the docs surface separately, and to ensure future audits catch any reversion.
Steps to reproduce
docs/api.mdat the/api/v1/memory/getendpoint section.sort_byparameter description (around line 890).effective_sortecho,get.sort_by.downgradedlog line, no silent fallback.Expected vs actual
effective_sortDTO echo, and mention the structured log event.Environment
The fix is in the same PR (https://github.com/Fearvox/EverOS/pull/new/proofstorm/r2-sort-override-observable). This issue is filed so the contract change is discoverable in the docs audit trail.