* docs: fix conversations/messages API reference to match live code The "current" /api/v1 sections described a fictional "V2" convention set (PATCH update, ?include=messages opt-in, 204 append response, created_at cursor) that was drafted but never actually shipped. The real shared handler (used by both /api/v1/* and the /v1/* backward-compat alias) uses PUT, includes messages by default via ?fields=/?fields=!messages, returns 201 with the created messages on append, and pages messages by ID. Corrects the Get/Update/Create Conversation and Append/List Messages sections, broadens the Authentication section (most non-conversation routes need Clerk session, not an API key), fixes /v1/projects/* paths that were never mounted (only /api/v1/projects/* is), and replaces the "Migration Guide (Historical)" narrative with a pointer to the already- accurate docs/v2-migration.md instead of duplicating (and getting wrong) the same information. Closes #300, #301, #332, #333, #334, #335, #336, #337, #338 Co-Authored-By: Duyet Le <me@duyet.net> Co-Authored-By: duyetbot <bot@duyet.net> * docs: document USE_SLIDING_WINDOW flag, correct stale VECTORIZE_INDEX claim USE_SLIDING_WINDOW gates the KV-backed sliding-window rate limiter (packages/api/src/middleware/rate-limit.ts) but was never documented, even though its RATE_LIMITS binding neighbor already was. Separately, the VECTORIZE_INDEX row promised a semantic-search feature with a 503 fallback; that code (services/embeddings.ts) was removed in the 2026-06-20 v2->v1 cleanup and the binding now has zero runtime consumers. GET /api/v1/conversations/search is a plain SQL LIKE search, unrelated to this binding. Closes #302, #288 Co-Authored-By: Duyet Le <me@duyet.net> Co-Authored-By: duyetbot <bot@duyet.net> * docs: fix stale reference to deleted lib/deprecation.ts v2-migration.md described setDeprecationHeaders/lib/deprecation.ts in the present tense, but the file was removed in the 2026-06-20 v2->v1 dead-code collapse. Switch to past tense so this historical-reference doc doesn't itself contain a stale claim. Closes #305 Co-Authored-By: Duyet Le <me@duyet.net> Co-Authored-By: duyetbot <bot@duyet.net> * docs: fix AGENTS.md dashboard dev-server port (3000 -> 4321) AGENTS.md is meant to carry the same guidance as CLAUDE.md for other agent tools, but its dashboard dev-server port was left at the old Next.js-era default (3000) after the migration to Astro, which serves on 4321 by default. CLAUDE.md and README.md already had it right. Closes #303 Co-Authored-By: Duyet Le <me@duyet.net> Co-Authored-By: duyetbot <bot@duyet.net> * docs: fix PLAN.md completed-work entry (dashboard is Astro, not Next.js) The dashboard was migrated from Next.js to Astro, but PLAN.md's Completed list never caught up. PLAN.md is read by the autonomous maintenance loop every iteration, so the wrong framework name risked sending future automation looking for next.config.js / App Router conventions that don't exist. Closes #304 Co-Authored-By: Duyet Le <me@duyet.net> Co-Authored-By: duyetbot <bot@duyet.net> * docs: fix README endpoint table (PUT not PATCH) and stale test count The endpoint table documented conversation update as PATCH (the route is PUT) and a separate ?include=messages row for a param that was never implemented (messages are included by default; fields/!messages is the real mechanism). Also updates the stale "276 tests" figure to the current count (353, per `cd packages/api && bunx vitest run`) and adds an MCP Server line to the feature list, since the remote/local MCP server is fully shipped but was never mentioned in the README. Closes #300, #301, #306 Co-Authored-By: Duyet Le <me@duyet.net> Co-Authored-By: duyetbot <bot@duyet.net> * docs: move MCP server to Shipped in ROADMAP, fix stale test count The MCP server (remote /api/mcp with OAuth 2.1 + PKCE, local stdio @agentstate/mcp package, docs/mcp.md write-up) is fully built and live, but ROADMAP.md still listed it under "Next -- Near-Term" as an unshipped idea -- risking adopters concluding the feature doesn't exist yet. Moves it to "Now -- Shipped" and updates the same stale "276 passing tests" figure fixed in README (current count: 353). Closes #286 Co-Authored-By: Duyet Le <me@duyet.net> Co-Authored-By: duyetbot <bot@duyet.net> * docs: clarify /v1/* is a frozen 4-resource alias, not a general mirror The team lead confirmed against index.ts (lines 209-212) that /v1/* is mounted for exactly four routers -- conversations, ai, tags, and analytics-public -- predating projects/states/leases/claims. The prior "routes under /v1/* mirror /api/v1/*" wording read as a blanket claim, which is precisely the ambiguity that led #333's audit to assume /v1/projects existed. Spell out the four resources explicitly so this doesn't recur. Follow-up to #333 per team-lead review. Co-Authored-By: Duyet Le <me@duyet.net> Co-Authored-By: duyetbot <bot@duyet.net> --------- Co-authored-by: duyetbot <bot@duyet.net>

[docs] Create-conversation response docs wrong about messages field #334

Description

Activity

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions