Conversation
…pps (bytefolk#73) - Update API.md with new query params (after, before, sort) and document that query now searches both title and content - Add host-app-integration.md guide for embedders consuming the search API - Update CAPABILITIES.md to reflect the expanded Document API v1 surface
The after/before params filter on updatedAt, not createdAt, per the buildDateWhere implementation in doc-query.ts.
Shows host apps how to verify after/before behavior and handle the 400 invalid_query error for malformed dates.
waterbro-8
left a comment
waterbro-8
left a comment
There was a problem hiding this comment.
CI test is red on Prettier. I cannot push sun-970/doc.
Please run:
npx prettier --write docs/API.md docs/CAPABILITIES.md docs/host-app-integration.md
then push. After format is green this docs PR looks mergeable (describes current list-API search/time/sort; correctly notes that matchField is not in the response yet).
waterbro-8
left a comment
waterbro-8
left a comment
There was a problem hiding this comment.
Re-review: Prettier on docs/API.md, docs/CAPABILITIES.md, and docs/host-app-integration.md is in c37ebc3, and CI test/docker-build are green.
This documents current list-API search / time / sort for host apps and correctly notes that matchField is not in the response yet. I cannot satisfy CODEOWNERS myself.
Bindy-lbb
left a comment
Bindy-lbb
left a comment
There was a problem hiding this comment.
Reviewed current head c37ebc3. Documentation accurately matches the implemented API behavior; CI is green and the Prettier follow-up is present.
Non-blocking docs nit: the September example uses before=2026-09-30, but before is strict, so it excludes all of September 30. Consider using before=2026-10-01 for a complete calendar-month example.
3 participants
Summary
Closes #73.
Companion to #68 / #69. PR #69 implements the API-side changes (content search, time range filters, sort options). This PR documents the new capabilities and provides a host-app integration guide so embedders (RoleWeave Memory & Collaboration, other embeddings) know how to consume them.
Changes
docs/API.md: UpdatedGET /api/v1/documentssection to document:querynow searches both title AND content (OR semantics)after/beforetime range filters (ISO 8601, filter onupdatedAt)sortparam (updated_desc,updated_asc,created_desc,created_asc)created_*sorts don't support cursor)docs/host-app-integration.md(new): Integration guide for host apps covering:docs/CAPABILITIES.md: Updated Document API v1 row to mention content search, time range filters, and sort options.Scope note
The host-app UI layer (search box, filter controls,
matchFieldrendering) lives in the host application repos (e.g.bytefolk/roleweave). This PR covers only the doc-side documentation that host apps consume.